0% found this document useful (0 votes)
76 views

Ansys Act API Reference Guide

Uploaded by

V Caf
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
76 views

Ansys Act API Reference Guide

Uploaded by

V Caf
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3796

ACT API Reference Guide

ANSYS, Inc. Release 2020 R1


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

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

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

Disclaimer Notice

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

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

U.S. Government Rights

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

Third-Party Software

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

Published in the U.S.A.


Table of Contents
Namespaces ................................................................................................................................................ 1
Ansys.ACT.Core Namespace ................................................................................................................. 3
ExtensionId ...................................................................................................................................... 3
UniqueId .................................................................................................................................... 3
ProcessUtilities ................................................................................................................................. 3
Start(string, params string[]) ........................................................................................................ 4
Start(string, bool, params string[]) ............................................................................................... 4
Ansys.ACT.Core.Application.DataModel Namespace .......................................................................... 5
IDataModelProvider .......................................................................................................................... 5
DataModel ................................................................................................................................. 5
Ansys.ACT.Core.Utilities Namespace .................................................................................................... 7
AttributeCollection ........................................................................................................................... 7
Item(string) ................................................................................................................................ 7
Keys ........................................................................................................................................... 8
Clone() ....................................................................................................................................... 8
Contains(string) .......................................................................................................................... 8
GetStringValue(string) ................................................................................................................ 8
GetValue(string) ......................................................................................................................... 8
GetValue(string, object) .............................................................................................................. 9
Remove(string) ........................................................................................................................... 9
SetValue(string, object) ............................................................................................................... 9
NamedCollection<T> ..................................................................................................................... 10
Item(string) .............................................................................................................................. 10
Names ...................................................................................................................................... 10
Ansys.Mechanical.Selection Namespace ........................................................................................... 11
SelectionHelper .............................................................................................................................. 11
CreateVector3D(ISelectionInfo, bool) ......................................................................................... 11
Ansys.Mechanical.Graphics Namespace ............................................................................................ 13
AnalysisSettingsGraph .................................................................................................................... 13
BoundaryConditionVisibility ..................................................................................................... 13
AnimationExportSettings ................................................................................................................ 13
AnimationExportSettings(int, int) .............................................................................................. 14
Height ...................................................................................................................................... 14
Width ....................................................................................................................................... 14
Graphics3DExportSettings .............................................................................................................. 14
Graphics3DExportSettings() ...................................................................................................... 15
Background .............................................................................................................................. 15
GraphicsImageExportSettings ......................................................................................................... 15
GraphicsImageExportSettings() ................................................................................................. 16
Background .............................................................................................................................. 16
Capture .................................................................................................................................... 16
CurrentGraphicsDisplay ............................................................................................................ 16
FontMagnification .................................................................................................................... 16
Height ...................................................................................................................................... 17
Resolution ................................................................................................................................ 17
Width ....................................................................................................................................... 17
Point .............................................................................................................................................. 17
Point(IList<object>, string) ........................................................................................................ 18
Location ................................................................................................................................... 18
Unit .......................................................................................................................................... 18

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

ResultAnimationOptions ................................................................................................................. 18
Duration ................................................................................................................................... 19
FitDeformationScalingToAnimation .......................................................................................... 19
NumberOfFrames ..................................................................................................................... 19
RangeType ............................................................................................................................... 19
TimeDecayCycles ...................................................................................................................... 19
UpdateContourRangeAtEachFrame .......................................................................................... 19
SectionPlane .................................................................................................................................. 20
SectionPlane() .......................................................................................................................... 20
SectionPlane(Point, Vector3D, string, SectionPlaneType, bool) .................................................... 20
Active ....................................................................................................................................... 21
Center ...................................................................................................................................... 21
Direction .................................................................................................................................. 21
Name ....................................................................................................................................... 21
Type ......................................................................................................................................... 22
Equals(SectionPlane) ................................................................................................................ 22
SectionPlanes ................................................................................................................................. 22
Capping ................................................................................................................................... 22
Count ....................................................................................................................................... 23
ShowWholeElement ................................................................................................................. 23
Add(SectionPlane) .................................................................................................................... 23
Clear() ...................................................................................................................................... 23
Remove(SectionPlane) .............................................................................................................. 23
RemoveAt(int) .......................................................................................................................... 24
Ansys.Mechanical.Application Namespace ........................................................................................ 25
Message ......................................................................................................................................... 25
DisplayString ............................................................................................................................ 25
Location ................................................................................................................................... 26
RelatedObjects ......................................................................................................................... 26
Severity .................................................................................................................................... 26
Source ...................................................................................................................................... 26
StringID .................................................................................................................................... 26
TimeStamp ............................................................................................................................... 26
Messages ....................................................................................................................................... 27
Count ....................................................................................................................................... 27
Add(Message) .......................................................................................................................... 27
Clear() ...................................................................................................................................... 27
Contains(Message) ................................................................................................................... 28
Remove(Message) .................................................................................................................... 28
ShowErrors() ............................................................................................................................. 28
ObjectTag ....................................................................................................................................... 28
ObjectTag(string) ...................................................................................................................... 29
Name ....................................................................................................................................... 29
Objects .................................................................................................................................... 29
AddObject(DataModelObject) .................................................................................................. 29
ClearObjects() ........................................................................................................................... 30
RemoveObject(DataModelObject) ............................................................................................ 30
ObjectTags ..................................................................................................................................... 30
Count ....................................................................................................................................... 31
Item(int) ................................................................................................................................... 31
Item(string) .............................................................................................................................. 31
TagNames ................................................................................................................................ 31

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

Add(ObjectTag) ........................................................................................................................ 31
Clear() ...................................................................................................................................... 31
Contains(ObjectTag) ................................................................................................................. 32
GetTag(string) .......................................................................................................................... 32
IndexOf(ObjectTag) .................................................................................................................. 32
Remove(ObjectTag) .................................................................................................................. 32
RemoveAt(int) .......................................................................................................................... 33
Progress ......................................................................................................................................... 33
SetProgress(uint, string, uint, string) ........................................................................................... 33
Ansys.ACT.Interfaces.Graphics Namespace ....................................................................................... 35
IModelViewManager ...................................................................................................................... 35
NumberOfViews ....................................................................................................................... 36
ApplyModelView(int) ................................................................................................................ 36
ApplyModelView(string) ........................................................................................................... 36
CaptureModelView(int, string) .................................................................................................. 36
CaptureModelView(string, string) .............................................................................................. 37
CreateView() ............................................................................................................................. 37
CreateView(string) .................................................................................................................... 37
DeleteView(int) ........................................................................................................................ 37
DeleteView(string) .................................................................................................................... 38
ExportModelViews(string) ........................................................................................................ 38
ImportModelViews(string) ........................................................................................................ 38
RenameView(int, string) ............................................................................................................ 38
RenameView(string, string) ....................................................................................................... 39
Ansys.ACT.Interfaces.Mechanical Namespace ................................................................................... 41
IMechanicalDataModel ................................................................................................................... 41
ObjectTags ............................................................................................................................... 42
Project ..................................................................................................................................... 42
Tree .......................................................................................................................................... 42
CurrentUnitFromQuantityName(string) ..................................................................................... 42
GetObjectById(int) .................................................................................................................... 42
GetObjectsByName(string) ....................................................................................................... 43
GetObjectsByType(DataModelObjectCategory) ......................................................................... 43
GetObjectsByType(Type) .......................................................................................................... 43
IMechanicalExtAPI .......................................................................................................................... 44
LockPrePostLicense() ................................................................................................................ 44
UnlockPrePostLicense() ............................................................................................................. 44
IMechanicalGraphics ...................................................................................................................... 44
ModelViewManager ................................................................................................................. 45
SectionPlanes ........................................................................................................................... 45
IMechanicalSelectionInfo ................................................................................................................ 45
ElementFaceIndices .................................................................................................................. 45
Entities ..................................................................................................................................... 45
IMechanicalUserLoad ...................................................................................................................... 46
IMechanicalUserObject ................................................................................................................... 46
Analysis .................................................................................................................................... 46
IMechanicalUserResult .................................................................................................................... 46
IMechanicalUserSolver .................................................................................................................... 46
MechanicalPanelEnum ................................................................................................................... 47
Ansys.ACT.Interfaces.DesignModeler Namespace ............................................................................. 49
IDesignModelerDataModel ............................................................................................................. 50
Components ............................................................................................................................ 50

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

GeoData ................................................................................................................................... 50
GeometryBuilder ...................................................................................................................... 51
Queries .................................................................................................................................... 51
ComponentById(int) ................................................................................................................. 51
CurrentUnitFromQuantityName(string) ..................................................................................... 51
IDesignModelerExtAPI .................................................................................................................... 51
IDesignModelerGeoData ................................................................................................................ 52
Bodies ...................................................................................................................................... 52
Parts ......................................................................................................................................... 52
IDesignModelerGeoFeature ............................................................................................................ 52
Bodies ...................................................................................................................................... 53
MaterialType ............................................................................................................................ 53
AddProblematicGeometry(IEnumerable<IPSGeoEntity>, string) ................................................ 53
IDesignModelerSelectionInfo .......................................................................................................... 53
Entities ..................................................................................................................................... 53
Locations .................................................................................................................................. 54
IExtrude ......................................................................................................................................... 54
Depth ....................................................................................................................................... 54
Direction .................................................................................................................................. 54
Walled ...................................................................................................................................... 54
ApplyTo(IPSGeoEntity) .............................................................................................................. 55
IGeometryBuilder ........................................................................................................................... 55
Operations ............................................................................................................................... 55
Primitives ................................................................................................................................. 55
IIntersect ........................................................................................................................................ 56
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 56
IOperations .................................................................................................................................... 56
Queries .................................................................................................................................... 57
Tools ........................................................................................................................................ 57
CreateExtrudeOperation(IEnumerable<double>, double) .......................................................... 57
CreateIntersectOperation(IEnumerable<IPSGeoBody>) ............................................................. 57
CreateRevolveOperation(IEnumerable<double>, IEnumerable<double>) .................................. 58
CreateSubtractOperation(IEnumerable<IPSGeoBody>) ............................................................. 58
CreateUnionOperation() ........................................................................................................... 58
IOperationTools .............................................................................................................................. 58
CopyBody(IPSGeoBody) ............................................................................................................ 59
CreatePart(IEnumerable<IPSGeoBody>) .................................................................................... 59
DeleteBody(IPSGeoBody) .......................................................................................................... 60
EdgesToWireBody(IEnumerable<IPSGeoEdge>) ........................................................................ 60
FacesToSheetBody(IEnumerable<IPSGeoFace>) ........................................................................ 60
Imprint(IPSGeoBody, IEnumerable<IPSGeoBody>) ..................................................................... 60
OffsetFace(IEnumerable<IPSGeoFace>, double) ........................................................................ 61
SheetBodyToSolidBody(IPSGeoBody) ........................................................................................ 61
SimplifyTopology(IPSGeoEntity) ................................................................................................ 61
ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, double, double) ..................................... 62
TransformBody(IPSGeoBody, Matrix4D) ..................................................................................... 62
WireToSheetBody(IPSGeoBody) ................................................................................................ 62
IPrimitives ...................................................................................................................................... 63
Sheet ....................................................................................................................................... 63
Solid ......................................................................................................................................... 63
Wire ......................................................................................................................................... 63
IPSGeoBody ................................................................................................................................... 63

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

IPSGeoEdge .................................................................................................................................... 64
IPSGeoEntity .................................................................................................................................. 64
IPSGeoFace .................................................................................................................................... 64
IPSGeoPart ..................................................................................................................................... 64
IQueries .......................................................................................................................................... 64
Clash(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) .............................................. 65
Coincidence(IPSGeoEntity, IPSGeoEntity) ................................................................................... 65
Containment(IPSGeoEntity, IPSGeoEntity) ................................................................................. 65
Distance(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) ......................................... 66
IRevolve ......................................................................................................................................... 66
Angle ....................................................................................................................................... 66
Axis .......................................................................................................................................... 66
Origin ....................................................................................................................................... 67
Walled ...................................................................................................................................... 67
ApplyTo(IPSGeoEntity) .............................................................................................................. 67
ISheetCone ..................................................................................................................................... 67
Center ...................................................................................................................................... 68
Direction .................................................................................................................................. 68
Radius1 .................................................................................................................................... 68
Radius2 .................................................................................................................................... 68
ISheetCylinder ................................................................................................................................ 68
Center ...................................................................................................................................... 69
Direction .................................................................................................................................. 69
Radius ...................................................................................................................................... 69
ISheetPolygon ................................................................................................................................ 69
Points ....................................................................................................................................... 69
ISheets ........................................................................................................................................... 70
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ..................................... 70
CreatePolygon(IEnumerable<double>) ..................................................................................... 70
ISheetSphere .................................................................................................................................. 71
Center ...................................................................................................................................... 71
Radius ...................................................................................................................................... 71
ISolidBox ........................................................................................................................................ 71
Point1 ...................................................................................................................................... 71
Point2 ...................................................................................................................................... 72
ISolidCone ...................................................................................................................................... 72
Center ...................................................................................................................................... 72
Direction .................................................................................................................................. 72
Radius1 .................................................................................................................................... 73
Radius2 .................................................................................................................................... 73
ISolidCylinder ................................................................................................................................. 73
Center ...................................................................................................................................... 73
Direction .................................................................................................................................. 73
Radius ...................................................................................................................................... 74
ISolids ............................................................................................................................................ 74
CreateBox(IEnumerable<double>, IEnumerable<double>) ........................................................ 74
CreateCone(IEnumerable<double>, IEnumerable<double>, double, double) ............................. 74
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ..................................... 75
CreateSphere(IEnumerable<double>, double) ........................................................................... 75
ISolidSphere ................................................................................................................................... 76
Center ...................................................................................................................................... 76
Radius ...................................................................................................................................... 76

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

ISubtract ........................................................................................................................................ 76
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 76
IUnion ............................................................................................................................................ 77
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 77
IWireArc ......................................................................................................................................... 77
Center ...................................................................................................................................... 78
EndAngle ................................................................................................................................. 78
Normal ..................................................................................................................................... 78
Radius ...................................................................................................................................... 78
StartAngle ................................................................................................................................ 78
XDir .......................................................................................................................................... 78
IWireBCurve ................................................................................................................................... 79
Closed ...................................................................................................................................... 79
Points ....................................................................................................................................... 79
IWireEllipse ..................................................................................................................................... 79
Center ...................................................................................................................................... 80
LargeRadius ............................................................................................................................. 80
Normal ..................................................................................................................................... 80
SmallRadius .............................................................................................................................. 80
XDir .......................................................................................................................................... 80
IWirePolyline .................................................................................................................................. 80
Points ....................................................................................................................................... 81
IWires ............................................................................................................................................. 81
CreateArc(double, IEnumerable<double>, IEnumerable<double>, IEnumerable<double>) ......... 81
CreateBCurve(IEnumerable<double>) ....................................................................................... 82
CreateEllipse(double, double, IEnumerable<double>, IEnumerable<double>, IEnumer-
able<double>) ......................................................................................................................... 82
CreatePolyline(IEnumerable<double>) ...................................................................................... 83
Ansys.ACT.DesignModeler.Primitives.Sheet Namespace ................................................................... 85
Cylinder .......................................................................................................................................... 85
Cylinder(GeometryBuilder, IEnumerable<double>, IEnumerable<double>, double) .................... 85
Center ...................................................................................................................................... 86
Direction .................................................................................................................................. 86
Radius ...................................................................................................................................... 86
Generate() ................................................................................................................................ 86
Ansys.ACT.Mechanical Namespace .................................................................................................... 87
Transaction ..................................................................................................................................... 87
Ansys.ACT.Mechanical.Fields Namespace .......................................................................................... 89
Field ............................................................................................................................................... 89
Inputs ...................................................................................................................................... 89
Name ....................................................................................................................................... 90
Output ..................................................................................................................................... 90
Range ............................................................................................................................................ 90
Maximum ................................................................................................................................. 90
Minimum ................................................................................................................................. 90
Variable .......................................................................................................................................... 91
DefinitionType .......................................................................................................................... 91
DiscreteValueCount .................................................................................................................. 92
DiscreteValues .......................................................................................................................... 92
Field ......................................................................................................................................... 92
Formula .................................................................................................................................... 92
Index ........................................................................................................................................ 92

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

IsInput ...................................................................................................................................... 92
IsOutput ................................................................................................................................... 93
MinMaxDiscreteValues .............................................................................................................. 93
Name ....................................................................................................................................... 93
QuantityName .......................................................................................................................... 93
Range ...................................................................................................................................... 93
Unit .......................................................................................................................................... 93
GetDiscreteValue(int) ................................................................................................................ 94
SetDiscreteValue(int, Quantity) .................................................................................................. 94
VariableDefinitionType ................................................................................................................... 94
Ansys.ACT.Mechanical.Fields.Adapters Namespace .......................................................................... 95
FieldAdapter ................................................................................................................................... 95
FieldAdapter(IDSBCInformation) ............................................................................................... 95
FieldProvider ............................................................................................................................ 96
ChangeFieldDefinitionType(AnsBCLVType, kEDDataType) .......................................................... 96
IDefinition ................................................................................................................................ 96
Adapt(IDSBCInformation) ................................................................................................... 96
Keywords ................................................................................................................................. 97
Constant ............................................................................................................................ 97
ConstantRamped ................................................................................................................ 97
Free .................................................................................................................................... 98
Function ............................................................................................................................. 98
Table .................................................................................................................................. 98
Get(kEDDataType) .............................................................................................................. 98
FieldAdapterManager ..................................................................................................................... 98
AdapterDefinitions ................................................................................................................... 99
RegisterNewAdapter(IDefinition) .............................................................................................. 99
UnregisterAdapter(int) .............................................................................................................. 99
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace ........................................... 101
ILinuxSettings ............................................................................................................................... 101
Active ..................................................................................................................................... 101
UserName .............................................................................................................................. 102
WorkingFolder ........................................................................................................................ 102
IQueueSettings ............................................................................................................................. 102
JobName ................................................................................................................................ 102
License ................................................................................................................................... 102
Name ..................................................................................................................................... 103
ISolveConfiguration ...................................................................................................................... 103
Default ................................................................................................................................... 103
Name ..................................................................................................................................... 103
Settings .................................................................................................................................. 103
SolveProcessSettings .............................................................................................................. 104
SetAsDefault() ........................................................................................................................ 104
ISolveProcessSettings ................................................................................................................... 104
AdditionalCommandLineArguments ....................................................................................... 105
CustomExecutablePath ........................................................................................................... 105
DistributeSolution .................................................................................................................. 105
GPUAccelerationDevice .......................................................................................................... 105
LicenseQueuing ...................................................................................................................... 105
ManualLinuxSettings .............................................................................................................. 106
ManualSolverMemorySettings ................................................................................................ 106
MaxNumberOfCores ............................................................................................................... 106

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

NumberOfGPUDevices ............................................................................................................ 106


SolveInSynchronousMode ...................................................................................................... 106
UserString .............................................................................................................................. 106
UseSharedLicense ................................................................................................................... 107
ISolverMemorySettings ................................................................................................................. 107
Active ..................................................................................................................................... 107
Database ................................................................................................................................ 107
Workspace .............................................................................................................................. 107
LinuxSettings ............................................................................................................................... 108
LinuxSettings() ....................................................................................................................... 108
Active ..................................................................................................................................... 108
UserName .............................................................................................................................. 108
WorkingFolder ........................................................................................................................ 108
QueueSettings .............................................................................................................................. 109
QueueSettings() ..................................................................................................................... 109
JobName ................................................................................................................................ 109
License ................................................................................................................................... 109
Name ..................................................................................................................................... 109
RSMQueue ................................................................................................................................... 110
HPCConfiguration ................................................................................................................... 110
HPCQueue .............................................................................................................................. 110
HPCType ................................................................................................................................. 110
Name ..................................................................................................................................... 110
SolveConfiguration ....................................................................................................................... 111
SolveConfiguration() ............................................................................................................... 111
SolveConfiguration(string) ...................................................................................................... 111
Default ................................................................................................................................... 111
Name ..................................................................................................................................... 112
Settings .................................................................................................................................. 112
SolveProcessSettings .............................................................................................................. 112
SetAsDefault() ........................................................................................................................ 112
SolveProcessSettings .................................................................................................................... 112
SolveProcessSettings() ............................................................................................................ 113
AdditionalCommandLineArguments ....................................................................................... 113
CustomExecutablePath ........................................................................................................... 113
DistributeSolution .................................................................................................................. 113
GPUAccelerationDevice .......................................................................................................... 114
LicenseQueuing ...................................................................................................................... 114
ManualLinuxSettings .............................................................................................................. 114
ManualSolverMemorySettings ................................................................................................ 114
MaxNumberOfCores ............................................................................................................... 114
NumberOfGPUDevices ............................................................................................................ 114
SolveInSynchronousMode ...................................................................................................... 115
UseSharedLicense ................................................................................................................... 115
SolverMemorySettings ................................................................................................................. 115
SolverMemorySettings() ......................................................................................................... 115
Active ..................................................................................................................................... 115
Database ................................................................................................................................ 116
Workspace .............................................................................................................................. 116
Ansys.ACT.Common Namespace ...................................................................................................... 117
CoordinateSystem ........................................................................................................................ 117
CoordinateSystem(CoordinateSystemTypeEnum) .................................................................... 117

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

CoordinateSystemType ........................................................................................................... 118


Id ........................................................................................................................................... 118
Matrix ..................................................................................................................................... 118
Name ..................................................................................................................................... 118
Origin ..................................................................................................................................... 118
XAxis ...................................................................................................................................... 119
YAxis ...................................................................................................................................... 119
ZAxis ...................................................................................................................................... 119
Ansys.ACT.Common.Graphics Namespace ....................................................................................... 121
DMCameraWrapper ...................................................................................................................... 121
DMGraphicsWrapper .................................................................................................................... 121
MechanicalCameraWrapper .......................................................................................................... 121
FocalPoint .............................................................................................................................. 122
SceneHeight ........................................................................................................................... 122
SceneWidth ............................................................................................................................ 122
UpVector ................................................................................................................................ 123
ViewVector ............................................................................................................................. 123
GetAsString(ApplicationType) ................................................................................................. 123
Rotate(double, CameraAxisType) ............................................................................................. 123
SetFit(ISelectionInfo) ............................................................................................................... 124
SetSpecificViewOrientation(ViewOrientationType) .................................................................. 124
MechanicalGraphicsWrapper ........................................................................................................ 124
Camera ................................................................................................................................... 125
KeyframeAnimationUtility ....................................................................................................... 125
ModelViewManager ............................................................................................................... 125
ResultAnimationOptions ......................................................................................................... 125
SectionPlanes ......................................................................................................................... 125
Unit ........................................................................................................................................ 125
Export3D(string, Graphics3DExportFormat, Graphics3DExportSettings) ................................... 126
ExportImage(string, GraphicsImageExportFormat, GraphicsImageExportSettings) .................... 126
ModelViewManager ..................................................................................................................... 126
ActiveViewPort ....................................................................................................................... 127
NumberOfViews ..................................................................................................................... 127
ApplyModelView(int) .............................................................................................................. 127
ApplyModelView(string) ......................................................................................................... 128
CreateView() ........................................................................................................................... 128
CreateView(string) .................................................................................................................. 128
DeleteView(int) ....................................................................................................................... 128
DeleteView(string) .................................................................................................................. 129
ExportModelViews(string) ....................................................................................................... 129
ImportModelViews(string) ...................................................................................................... 129
RenameView(int, string) .......................................................................................................... 130
RenameView(string, string) ..................................................................................................... 130
SetActiveViewPort(int) ............................................................................................................ 130
SetActiveViewPort(int, int) ....................................................................................................... 130
SetViewPorts(int, bool) ............................................................................................................ 131
Ansys.ACT.Automation.DesignModeler Namespace ....................................................................... 133
Extrusion ...................................................................................................................................... 133
Depth ..................................................................................................................................... 133
Depth2 ................................................................................................................................... 134
Thin1 ...................................................................................................................................... 134
Thin2 ...................................................................................................................................... 134

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

Walled .................................................................................................................................... 134


Feature ......................................................................................................................................... 134
Id ........................................................................................................................................... 135
Name ..................................................................................................................................... 135
FeatureManager ........................................................................................................................... 135
Count ..................................................................................................................................... 135
Item(int) ................................................................................................................................. 135
CreateNamedSelection() ......................................................................................................... 136
Generate() .............................................................................................................................. 136
NamedSelection ........................................................................................................................... 136
ExportNamedSelection ........................................................................................................... 136
IncludeInLegend ..................................................................................................................... 137
NumGeometry ....................................................................................................................... 137
PropagateNamedSelection ..................................................................................................... 137
Ansys.ACT.Automation.Mechanical Namespace .............................................................................. 139
AcousticsFarFieldResultWorksheet ................................................................................................ 143
RowCount .............................................................................................................................. 143
AddRow() ............................................................................................................................... 144
DeleteRow(int) ....................................................................................................................... 144
DuplicateRow(int, int) ............................................................................................................. 144
GetCoordinateSystemSelection(int) ........................................................................................ 144
GetXCoordinate(int) ................................................................................................................ 145
GetYCoordinate(int) ................................................................................................................ 145
GetZCoordinate(int) ................................................................................................................ 145
InsertRow(int) ......................................................................................................................... 145
SetCoordinateSystemSelection(int, uint) .................................................................................. 146
SetXCoordinate(int, double) .................................................................................................... 146
SetYCoordinate(int, double) .................................................................................................... 146
SetZCoordinate(int, double) .................................................................................................... 147
AMOverhangConstraint ................................................................................................................ 147
BuildDirection ........................................................................................................................ 147
CoordinateSystem .................................................................................................................. 148
DataModelObjectCategory ..................................................................................................... 148
InternalObject ........................................................................................................................ 148
OverhangAngle ...................................................................................................................... 148
ScopingMethod ...................................................................................................................... 148
Selection ................................................................................................................................ 148
Suppressed ............................................................................................................................ 149
Delete() .................................................................................................................................. 149
Analysis ........................................................................................................................................ 149
Acoustics ................................................................................................................................ 153
AMProcessSimulation ............................................................................................................. 153
AnalysisSettings ..................................................................................................................... 153
AnalysisType ........................................................................................................................... 154
CellId ...................................................................................................................................... 154
Children ................................................................................................................................. 154
Comments .............................................................................................................................. 154
DataModelObjectCategory ..................................................................................................... 154
EnvironmentTemperature ....................................................................................................... 154
Figures ................................................................................................................................... 155
GenerateInputOnly ................................................................................................................. 155
Images ................................................................................................................................... 155

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

InitialConditions ..................................................................................................................... 155


InternalObject ........................................................................................................................ 155
PhysicsType ............................................................................................................................ 155
Solution ................................................................................................................................. 156
Structural ............................................................................................................................... 156
SystemCaption ....................................................................................................................... 156
AddAcceleration() ................................................................................................................... 156
AddAcousticAbsorptionElement() ........................................................................................... 156
AddAcousticAbsorptionSurface() ............................................................................................ 156
AddAcousticDiffuseSoundField() ............................................................................................. 157
AddAcousticFarFieldRadationSurface() .................................................................................... 157
AddAcousticFreeSurface() ....................................................................................................... 157
AddAcousticImpedanceBoundary() ......................................................................................... 157
AddAcousticImpedanceSheet() ............................................................................................... 157
AddAcousticIncidentWaveSource() .......................................................................................... 157
AddAcousticLowReducedFrequency() ..................................................................................... 158
AddAcousticMassSource() ....................................................................................................... 158
AddAcousticPort() .................................................................................................................. 158
AddAcousticPortInDuct() ........................................................................................................ 158
AddAcousticPressure() ............................................................................................................ 158
AddAcousticRadiationBoundary() ........................................................................................... 158
AddAcousticRigidWall() ........................................................................................................... 159
AddAcousticStaticPressure() .................................................................................................... 159
AddAcousticSurfaceVelocity() ................................................................................................. 159
AddAcousticSymmetryPlane() ................................................................................................. 159
AddAcousticTemperature() ..................................................................................................... 159
AddAcousticThermoViscousBLIBoundary() .............................................................................. 159
AddAcousticTransferAdmittanceMatrix() ................................................................................. 160
AddAMOverhangConstraint() .................................................................................................. 160
AddBearingLoad() ................................................................................................................... 160
AddBodyControl() ................................................................................................................... 160
AddBoltPretension() ............................................................................................................... 160
AddCenterOfGravityConstraint() ............................................................................................. 160
AddCommandSnippet() .......................................................................................................... 161
AddComment() ....................................................................................................................... 161
AddComplianceConstraint() .................................................................................................... 161
AddCompressionOnlySupport() .............................................................................................. 161
AddConstraintEquation() ........................................................................................................ 161
AddContactStepControl() ........................................................................................................ 161
AddConvection() .................................................................................................................... 162
AddCoupling() ........................................................................................................................ 162
AddCriterionConstraint() ......................................................................................................... 162
AddCurrent() .......................................................................................................................... 162
AddCyclicManufacturingConstraint() ....................................................................................... 162
AddCylindricalSupport() ......................................................................................................... 162
AddDetonationPoint() ............................................................................................................. 163
AddDisplacement() ................................................................................................................. 163
AddDisplacementConstraint() ................................................................................................. 163
AddEarthGravity() ................................................................................................................... 163
AddElasticSupport() ................................................................................................................ 163
AddElementBirthAndDeath() .................................................................................................. 163
AddEMTransducer() ................................................................................................................ 164

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

AddExtrusionManufacturingConstraint() ................................................................................. 164


AddFigure() ............................................................................................................................ 164
AddFixedRotation() ................................................................................................................. 164
AddFixedSupport() ................................................................................................................. 164
AddFluidSolidInterface() ......................................................................................................... 164
AddForce() .............................................................................................................................. 165
AddFrictionlessSupport() ........................................................................................................ 165
AddGeneralizedPlaneStrain() .................................................................................................. 165
AddGlobalVonMisesStressConstraint() ..................................................................................... 165
AddHeatFlow() ....................................................................................................................... 165
AddHeatFlux() ........................................................................................................................ 165
AddHydrostaticPressure() ........................................................................................................ 166
AddImage(string) ................................................................................................................... 166
AddImpedanceBoundary() ...................................................................................................... 166
AddImportedLoadResultFile() ................................................................................................. 166
AddInitialVelocity() ................................................................................................................. 166
AddInternalHeatGeneration() .................................................................................................. 166
AddJointLoad() ....................................................................................................................... 167
AddLinePressure() ................................................................................................................... 167
AddLocalVonMisesStressConstraint() ....................................................................................... 167
AddMagneticFluxParallel() ...................................................................................................... 167
AddMassConstraint() .............................................................................................................. 167
AddMassFlowRate() ................................................................................................................ 167
AddMemberSizeManufacturingConstraint() ............................................................................ 168
AddMoment() ......................................................................................................................... 168
AddMomentOfInertiaConstraint() ........................................................................................... 168
AddNaturalFrequencyConstraint() ........................................................................................... 168
AddNodalDisplacement() ........................................................................................................ 168
AddNodalForce() .................................................................................................................... 168
AddNodalOrientation() ........................................................................................................... 169
AddNodalPressure() ................................................................................................................ 169
AddNodalRotation() ................................................................................................................ 169
AddNonlinearAdaptiveRegion() .............................................................................................. 169
AddObjective() ....................................................................................................................... 169
AddOptimizationRegion() ....................................................................................................... 169
AddPerfectlyInsulated() .......................................................................................................... 170
AddPhysicsRegion() ................................................................................................................ 170
AddPipePressure() .................................................................................................................. 170
AddPipeTemperature() ............................................................................................................ 170
AddPlasticHeating() ................................................................................................................ 170
AddPressure() ......................................................................................................................... 170
AddPSDAcceleration() ............................................................................................................. 171
AddPSDDisplacement() ........................................................................................................... 171
AddPSDGAcceleration() .......................................................................................................... 171
AddPSDVelocity() .................................................................................................................... 171
AddPullOutDirectionManufacturingConstraint() ...................................................................... 171
AddRadiation() ....................................................................................................................... 171
AddReactionForceConstraint() ................................................................................................ 172
AddRemoteDisplacement() ..................................................................................................... 172
AddRemoteForce() .................................................................................................................. 172
AddRotatingForce() ................................................................................................................ 172
AddRotationalAcceleration() ................................................................................................... 172

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

AddRotationalVelocity() .......................................................................................................... 172


AddRSAcceleration() ............................................................................................................... 173
AddRSDisplacement() ............................................................................................................. 173
AddRSVelocity() ...................................................................................................................... 173
AddSimplySupported() ........................................................................................................... 173
AddSourceConductor() ........................................................................................................... 173
AddSymmetryManufacturingConstraint() ................................................................................ 173
AddSystemCouplingRegion() .................................................................................................. 174
AddTemperature() .................................................................................................................. 174
AddTemperatureConstraint() .................................................................................................. 174
AddThermalCondition() .......................................................................................................... 174
AddVelocity() .......................................................................................................................... 174
AddViscoelasticHeating() ........................................................................................................ 174
AddVoltage() .......................................................................................................................... 175
AddVolumeConstraint() .......................................................................................................... 175
ClearGeneratedData() ............................................................................................................. 175
CreateAutomaticFarFieldRadiationSurfaces() ........................................................................... 175
CreateAutomaticFSI() .............................................................................................................. 175
CreateAutomaticFSIandFarFieldRadiationSurfaces() ................................................................. 175
ExportNastranFile(NastranExportOptions) ............................................................................... 176
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 176
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 176
ImportLoad(Analysis) .............................................................................................................. 177
OpenSolverFilesDirectory() ..................................................................................................... 177
Solve(bool) ............................................................................................................................. 177
Solve(bool, string) ................................................................................................................... 177
TransferDataFrom(Analysis) ..................................................................................................... 178
UnlinkDataFrom(Analysis) ....................................................................................................... 178
WriteSystemCouplingFiles(string) ............................................................................................ 178
AnalysisPly ................................................................................................................................... 178
Angle ..................................................................................................................................... 179
Children ................................................................................................................................. 179
Comments .............................................................................................................................. 180
DataModelObjectCategory ..................................................................................................... 180
Figures ................................................................................................................................... 180
IDInSource .............................................................................................................................. 180
Images ................................................................................................................................... 180
InternalObject ........................................................................................................................ 180
Material .................................................................................................................................. 181
NameInSource ........................................................................................................................ 181
NumberOfElements ................................................................................................................ 181
Thickness ............................................................................................................................... 181
AddComment() ....................................................................................................................... 181
AddFigure() ............................................................................................................................ 181
AddImage(string) ................................................................................................................... 182
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 182
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 182
ArbitraryCrack .............................................................................................................................. 183
BottomFaceNodes .................................................................................................................. 184
CircumferentialDivisions ......................................................................................................... 184
CoordinateSystem .................................................................................................................. 184
CrackFacesNodes .................................................................................................................... 184

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

CrackFrontNodes .................................................................................................................... 184


CrackMeshMethod ................................................................................................................. 184
CrackShape ............................................................................................................................ 185
CrackSourceType .................................................................................................................... 185
CrackSurfaceLocation ............................................................................................................. 185
DataModelObjectCategory ..................................................................................................... 185
FrontElementSize .................................................................................................................... 185
GrowthRate ............................................................................................................................ 185
InternalObject ........................................................................................................................ 186
LargestContourRadius ............................................................................................................ 186
Location ................................................................................................................................. 186
MeshContours ........................................................................................................................ 186
SolutionContours ................................................................................................................... 186
Suppressed ............................................................................................................................ 186
TopFaceNodes ........................................................................................................................ 187
XScaleFactor ........................................................................................................................... 187
YScaleFactor ........................................................................................................................... 187
ZScaleFactor ........................................................................................................................... 187
BatchConnectionsWorksheet ........................................................................................................ 187
RowCount .............................................................................................................................. 188
AddRow() ............................................................................................................................... 188
ClearGenerateMesh() .............................................................................................................. 188
DeleteAllRows() ...................................................................................................................... 188
DeleteRow(int) ....................................................................................................................... 189
GenerateAtRow(int) ................................................................................................................ 189
GenerateMesh() ...................................................................................................................... 189
GetActiveState(int) ................................................................................................................. 189
GetConnectionOption(int) ...................................................................................................... 190
GetConnectionTolerances(int) ................................................................................................. 190
GetNamedSelection(int) ......................................................................................................... 190
GetNamedSelectionId(int) ...................................................................................................... 190
SetActiveState(int, bool) .......................................................................................................... 191
SetConnectionOption(int, int) ................................................................................................. 191
SetConnectionTolerances(int, string) ....................................................................................... 191
SetNamedSelection(int, NamedSelection) ............................................................................... 192
SetNamedSelectionId(int, uint) ................................................................................................ 192
Body ............................................................................................................................................ 192
Assignment ***OBSOLETE*** Use 'Material' property instead. .................................................. 195
Average .................................................................................................................................. 195
BeamSection .......................................................................................................................... 195
Behavior ................................................................................................................................. 195
BrickIntegrationScheme .......................................................................................................... 196
CentroidX ............................................................................................................................... 196
CentroidY ............................................................................................................................... 196
CentroidZ ............................................................................................................................... 196
Children ................................................................................................................................. 196
Comments .............................................................................................................................. 196
CoordinateSystem .................................................................................................................. 197
CrossSectionArea .................................................................................................................... 197
CrossSectionIYY ...................................................................................................................... 197
CrossSectionIZZ ...................................................................................................................... 197
CrossSectionName .................................................................................................................. 197

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

CrossSectionSelection ............................................................................................................ 197


DataModelObjectCategory ..................................................................................................... 198
Dimension .............................................................................................................................. 198
Elements ................................................................................................................................ 198
Figures ................................................................................................................................... 198
FluidCrossArea ........................................................................................................................ 198
FluidDiscretization .................................................................................................................. 198
FluidSolidPhase ...................................................................................................................... 199
Hidden ................................................................................................................................... 199
Images ................................................................................................................................... 199
InternalObject ........................................................................................................................ 199
IsWindingBody ....................................................................................................................... 199
Length ................................................................................................................................... 199
LengthX ................................................................................................................................. 200
LengthY ................................................................................................................................. 200
LengthZ ................................................................................................................................. 200
LinkTrussBehavior ................................................................................................................... 200
ManualThicknessMode ........................................................................................................... 200
Mass ....................................................................................................................................... 200
Material .................................................................................................................................. 201
Maximum ............................................................................................................................... 201
MeshMetric ............................................................................................................................ 201
MeshVersion ........................................................................................................................... 201
Minimum ............................................................................................................................... 201
ModelType ............................................................................................................................. 201
MomentOfInertiaIp1 ............................................................................................................... 202
MomentOfInertiaIp2 ............................................................................................................... 202
MomentOfInertiaIp3 ............................................................................................................... 202
Nodes ..................................................................................................................................... 202
NonlinearEffects ..................................................................................................................... 202
NumberOfTurns ...................................................................................................................... 202
OffsetMode ............................................................................................................................ 203
OffsetType .............................................................................................................................. 203
OffsetX ................................................................................................................................... 203
OffsetY ................................................................................................................................... 203
PipeExternalDiameter ............................................................................................................. 203
PipeInternalDiameter .............................................................................................................. 203
PipeThickness ......................................................................................................................... 204
ReadOnly ................................................................................................................................ 204
ReferenceFrame ...................................................................................................................... 204
ReferenceTemperature ***OBSOLETE*** Use 'UseReferenceTemperatureByBody' property in-
stead. ..................................................................................................................................... 204
ReferenceTemperatureValue ................................................................................................... 204
ShellOffsetType ...................................................................................................................... 204
StandardDeviation .................................................................................................................. 205
StiffnessBehavior .................................................................................................................... 205
Suppressed ............................................................................................................................ 205
SurfaceArea ............................................................................................................................ 205
ThermalStrainEffects ............................................................................................................... 205
Thickness ............................................................................................................................... 205
ThicknessMode ***OBSOLETE*** Use 'ManualThicknessMode' property instead. ...................... 206
Treatment ............................................................................................................................... 206

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

UseReferenceTemperatureByBody .......................................................................................... 206


UserNameChange ................................................................................................................... 206
Visible .................................................................................................................................... 206
Volume ................................................................................................................................... 206
AddCommandSnippet() .......................................................................................................... 207
AddComment() ....................................................................................................................... 207
AddFigure() ............................................................................................................................ 207
AddImage(string) ................................................................................................................... 207
ClearGeneratedData() ............................................................................................................. 207
GenerateMesh() ...................................................................................................................... 208
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 208
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 208
GetGeoBody() ......................................................................................................................... 208
PreviewInflation() ................................................................................................................... 209
PreviewSurfaceMesh() ............................................................................................................ 209
ShowBody() ............................................................................................................................ 209
Update() ................................................................................................................................. 209
CenterOfGravityConstraint ............................................................................................................ 209
Axis ........................................................................................................................................ 210
DataModelObjectCategory ..................................................................................................... 210
InternalObject ........................................................................................................................ 210
MaximumPosition ................................................................................................................... 210
MnimumPosition .................................................................................................................... 210
Suppressed ............................................................................................................................ 211
Delete() .................................................................................................................................. 211
Chart ............................................................................................................................................ 211
Caption .................................................................................................................................. 212
Children ................................................................................................................................. 212
Comments .............................................................................................................................. 212
Content .................................................................................................................................. 212
DataModelObjectCategory ..................................................................................................... 212
Gridlines ................................................................................................................................. 213
Images ................................................................................................................................... 213
InternalObject ........................................................................................................................ 213
ModalDisplayType .................................................................................................................. 213
OutlineSelection ..................................................................................................................... 213
PlotStyle ................................................................................................................................. 213
Scale ...................................................................................................................................... 214
XAxis ...................................................................................................................................... 214
XAxisLabel .............................................................................................................................. 214
YAxisLabel .............................................................................................................................. 214
AddComment() ....................................................................................................................... 214
AddImage(string) ................................................................................................................... 214
Delete() .................................................................................................................................. 215
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 215
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 215
ChartXAxis .................................................................................................................................... 216
ComponentIndex ................................................................................................................... 216
ObjectSelection ...................................................................................................................... 216
CommandSnippet ........................................................................................................................ 216
Children ................................................................................................................................. 217
Comments .............................................................................................................................. 218

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

DataModelObjectCategory ..................................................................................................... 218


Figures ................................................................................................................................... 218
FileName ................................................................................................................................ 218
Images ................................................................................................................................... 218
Input ...................................................................................................................................... 218
InputArgument1 ..................................................................................................................... 219
InputArgument2 ..................................................................................................................... 219
InputArgument3 ..................................................................................................................... 219
InputArgument4 ..................................................................................................................... 219
InputArgument5 ..................................................................................................................... 219
InputArgument6 ..................................................................................................................... 219
InputArgument7 ..................................................................................................................... 220
InputArgument8 ..................................................................................................................... 220
InputArgument9 ..................................................................................................................... 220
InternalObject ........................................................................................................................ 220
InvalidateSolution ................................................................................................................... 220
OutputParameters .................................................................................................................. 220
OutputSearchPrefix ................................................................................................................ 221
SnippetFileStatus .................................................................................................................... 221
SolverTarget ........................................................................................................................... 221
StepNumber ........................................................................................................................... 221
StepSelectionMode ................................................................................................................ 221
Suppressed ............................................................................................................................ 221
AddComment() ....................................................................................................................... 222
AddFigure() ............................................................................................................................ 222
AddImage(string) ................................................................................................................... 222
AppendText(string) ................................................................................................................. 222
Delete() .................................................................................................................................. 222
ExportTextFile(string) .............................................................................................................. 223
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 223
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 223
ImportTextFile(string) ............................................................................................................. 224
Comment ..................................................................................................................................... 224
Author .................................................................................................................................... 224
Children ................................................................................................................................. 225
DataModelObjectCategory ..................................................................................................... 225
InternalObject ........................................................................................................................ 225
Text ........................................................................................................................................ 225
Delete() .................................................................................................................................. 225
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 225
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 226
ComplianceConstraint .................................................................................................................. 226
ComplianceLimit .................................................................................................................... 226
DataModelObjectCategory ..................................................................................................... 227
InternalObject ........................................................................................................................ 227
Suppressed ............................................................................................................................ 227
Delete() .................................................................................................................................. 227
CompositeCriterion ...................................................................................................................... 227
DataModelObjectCategory ..................................................................................................... 228
InternalObject ........................................................................................................................ 228
ClearGeneratedData() ............................................................................................................. 228
EvaluateAllResults() ................................................................................................................. 229

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

GetDefinition() ........................................................................................................................ 229


CompositeCriterionDefinition ....................................................................................................... 229
Count ..................................................................................................................................... 229
Item(int) ................................................................................................................................. 230
Add(CompositeCriterionTerm) ................................................................................................ 230
Clear() .................................................................................................................................... 230
IndexOf(CompositeCriterionTerm) .......................................................................................... 230
Insert(int, CompositeCriterionTerm) ......................................................................................... 230
RemoveAt(int) ........................................................................................................................ 231
CompositeCriterionTerm ............................................................................................................... 231
CompositeCriterionTerm() ....................................................................................................... 232
CompositeCriterionTerm(PrimaryCriterion, double) ................................................................. 232
Coefficient .............................................................................................................................. 232
PrimaryCriterion ..................................................................................................................... 232
CondensedGeometry .................................................................................................................... 232
Children ................................................................................................................................. 233
Comments .............................................................................................................................. 233
DataModelObjectCategory ..................................................................................................... 234
Figures ................................................................................................................................... 234
Images ................................................................................................................................... 234
InternalObject ........................................................................................................................ 234
SolverFilesDirectory ................................................................................................................ 234
TransparencyEnabled ............................................................................................................. 234
AddComment() ....................................................................................................................... 235
AddCondensedPart() .............................................................................................................. 235
AddCondensedPartInfoTool() .................................................................................................. 235
AddFigure() ............................................................................................................................ 235
AddImage(string) ................................................................................................................... 235
ClearGeneratedData() ............................................................................................................. 235
Delete() .................................................................................................................................. 236
GenerateCondensedParts() ..................................................................................................... 236
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 236
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 236
CondensedPart ............................................................................................................................. 237
AttachmentMethod ................................................................................................................ 238
Children ................................................................................................................................. 238
Comments .............................................................................................................................. 238
DataModelObjectCategory ..................................................................................................... 238
Figures ................................................................................................................................... 239
FutureExpansion ..................................................................................................................... 239
FutureIntent ........................................................................................................................... 239
GenerateDampingMatrix ........................................................................................................ 239
GeometrySelection ................................................................................................................. 239
Images ................................................................................................................................... 239
InterfaceMethod ..................................................................................................................... 240
InternalObject ........................................................................................................................ 240
MaximumFrequency ............................................................................................................... 240
MinimumFrequency ............................................................................................................... 240
NumberInterfaceEntries .......................................................................................................... 240
NumberMasterNodes ............................................................................................................. 240
NumberOfModes .................................................................................................................... 241
Physics ................................................................................................................................... 241

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

RangeSearch .......................................................................................................................... 241


ReductionMethod .................................................................................................................. 241
ReferenceTemperature ............................................................................................................ 241
SolutionName ........................................................................................................................ 241
SolutionNameMode ................................................................................................................ 242
SolverFilesDirectory ................................................................................................................ 242
SolverType .............................................................................................................................. 242
SolverUnits ............................................................................................................................. 242
StoreBasisResults .................................................................................................................... 242
Suppressed ............................................................................................................................ 242
TemperatureUnits ................................................................................................................... 243
AddComment() ....................................................................................................................... 243
AddFigure() ............................................................................................................................ 243
AddImage(string) ................................................................................................................... 243
ClearGeneratedData() ............................................................................................................. 243
Delete() .................................................................................................................................. 244
DetectCondensedPartInterface() ............................................................................................. 244
GenerateCondensedParts() ..................................................................................................... 244
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 244
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 244
CondensedPartExpansionState ..................................................................................................... 245
CondensedPartExpansionState() ............................................................................................. 245
Displacement ......................................................................................................................... 245
Stress ..................................................................................................................................... 245
CondensedPartInfoTool ................................................................................................................ 246
Children ................................................................................................................................. 246
Comments .............................................................................................................................. 246
DataModelObjectCategory ..................................................................................................... 246
Images ................................................................................................................................... 247
InternalObject ........................................................................................................................ 247
Text ........................................................................................................................................ 247
UpdateInterval ....................................................................................................................... 247
AddComment() ....................................................................................................................... 247
AddImage(string) ................................................................................................................... 247
Delete() .................................................................................................................................. 248
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 248
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 248
ConstructionGeometry ................................................................................................................. 249
Children ................................................................................................................................. 249
Comments .............................................................................................................................. 250
DataModelObjectCategory ..................................................................................................... 250
Figures ................................................................................................................................... 250
Images ................................................................................................................................... 250
InternalObject ........................................................................................................................ 250
ShowMesh ............................................................................................................................. 250
AddComment() ....................................................................................................................... 251
AddFigure() ............................................................................................................................ 251
AddImage(string) ................................................................................................................... 251
AddPath() ............................................................................................................................... 251
AddSolid() .............................................................................................................................. 251
AddSTL() ................................................................................................................................. 251
AddSurface() .......................................................................................................................... 252

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

Delete() .................................................................................................................................. 252


GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 252
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 252
ContactDebonding ....................................................................................................................... 253
ContactRegion ........................................................................................................................ 253
CriticalRate ............................................................................................................................. 253
DataModelObjectCategory ..................................................................................................... 254
FailureCriteriaOption .............................................................................................................. 254
GenerationMethod ................................................................................................................. 254
InitialCrack ............................................................................................................................. 254
InitialTimeStep ....................................................................................................................... 254
InternalObject ........................................................................................................................ 254
Material .................................................................................................................................. 255
MaximumTimeStep ................................................................................................................ 255
Method .................................................................................................................................. 255
MinimumTimeStep ................................................................................................................. 255
Suppressed ............................................................................................................................ 255
Type ....................................................................................................................................... 255
Delete() .................................................................................................................................. 256
ContactMatch ............................................................................................................................... 256
DataModelObjectCategory ..................................................................................................... 257
InternalObject ........................................................................................................................ 258
ContactMatchGroup ..................................................................................................................... 258
DataModelObjectCategory ..................................................................................................... 260
InternalObject ........................................................................................................................ 260
ContactSolutionInformation ......................................................................................................... 260
Children ................................................................................................................................. 261
Comments .............................................................................................................................. 261
DataModelObjectCategory ..................................................................................................... 261
Images ................................................................................................................................... 261
InternalObject ........................................................................................................................ 261
UpdateInterval ....................................................................................................................... 262
AddComment() ....................................................................................................................... 262
AddImage(string) ................................................................................................................... 262
Delete() .................................................................................................................................. 262
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 262
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 263
CoordinateSystem ........................................................................................................................ 263
APDLName ............................................................................................................................. 265
Children ................................................................................................................................. 265
Comments .............................................................................................................................. 265
CoordinateSystemID ............................................................................................................... 265
CoordinateSystemIDGeneration .............................................................................................. 265
CoordinateSystemType ........................................................................................................... 265
DataModelObjectCategory ..................................................................................................... 266
Figures ................................................................................................................................... 266
GloballyAvailable .................................................................................................................... 266
Images ................................................................................................................................... 266
InternalObject ........................................................................................................................ 266
IsGlobal .................................................................................................................................. 266
OriginLocation ........................................................................................................................ 267
OriginX ................................................................................................................................... 267

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

OriginY ................................................................................................................................... 267


OriginZ ................................................................................................................................... 267
PrimaryAxis ............................................................................................................................ 267
PrimaryAxisDefineBy .............................................................................................................. 267
PrimaryAxisLocation ............................................................................................................... 268
ReadOnly ................................................................................................................................ 268
SecondaryAxis ........................................................................................................................ 268
SecondaryAxisDefineBy .......................................................................................................... 268
SecondaryAxisLocation ........................................................................................................... 268
Suppressed ............................................................................................................................ 268
TransformationCount .............................................................................................................. 269
TransformedConfiguration ...................................................................................................... 269
XAxisData ............................................................................................................................... 269
YAxisData ............................................................................................................................... 269
ZAxisData ............................................................................................................................... 269
AddComment() ....................................................................................................................... 269
AddFigure() ............................................................................................................................ 270
AddImage(string) ................................................................................................................... 270
AddTransformation(TransformationType, CoordinateSystemAxisType) ..................................... 270
CreateConstructionSurface() ................................................................................................... 270
CreateSectionPlane() .............................................................................................................. 271
Delete() .................................................................................................................................. 271
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 271
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 271
GetTransformationValue(uint) ................................................................................................. 272
MoveTransformationDown(uint) ............................................................................................. 272
MoveTransformationUp(uint) .................................................................................................. 272
RemoveTransformation(uint) .................................................................................................. 272
SetOriginLocation(Quantity, Quantity, Quantity) ...................................................................... 273
SetTransformationValue(uint, object) ....................................................................................... 273
CoordinateSystems ....................................................................................................................... 273
Children ................................................................................................................................. 274
Comments .............................................................................................................................. 274
DataModelObjectCategory ..................................................................................................... 274
Figures ................................................................................................................................... 275
Images ................................................................................................................................... 275
InternalObject ........................................................................................................................ 275
AddComment() ....................................................................................................................... 275
AddCoordinateSystem() .......................................................................................................... 275
AddFigure() ............................................................................................................................ 275
AddImage(string) ................................................................................................................... 276
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 276
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 276
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack instead. ........... 277
AlignWithFaceNormal ............................................................................................................. 278
BottomFaceNodes .................................................................................................................. 278
CircumferentialDivisions ......................................................................................................... 278
Contact1Nodes ....................................................................................................................... 278
ContactPairsNodes ................................................................................................................. 278
CoordinateSystem .................................................................................................................. 279
CrackFacesNodes .................................................................................................................... 279
CrackFrontDivisions ................................................................................................................ 279

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

CrackFrontNodes .................................................................................................................... 279


CrackShape ............................................................................................................................ 279
CrackSourceType .................................................................................................................... 279
FaceTopNodes ........................................................................................................................ 280
FractureAffectedZone ............................................................................................................. 280
FractureAffectedZoneHeight ................................................................................................... 280
InternalObject ........................................................................................................................ 280
LargestContourRadius ............................................................................................................ 280
Location ................................................................................................................................. 280
MajorRadius ........................................................................................................................... 281
MeshContours ........................................................................................................................ 281
MinorRadius ........................................................................................................................... 281
ProjectToNearestSurface ......................................................................................................... 281
SolutionContours ................................................................................................................... 281
Suppressed ............................................................................................................................ 281
Target1Nodes ......................................................................................................................... 282
XScaleFactor ........................................................................................................................... 282
YScaleFactor ........................................................................................................................... 282
ZScaleFactor ........................................................................................................................... 282
Criterion ....................................................................................................................................... 282
Children ................................................................................................................................. 283
Comments .............................................................................................................................. 283
DataModelObjectCategory ..................................................................................................... 283
Figures ................................................................................................................................... 283
Images ................................................................................................................................... 284
InternalObject ........................................................................................................................ 284
Suppressed ............................................................................................................................ 284
Value ...................................................................................................................................... 284
AddComment() ....................................................................................................................... 284
AddFigure() ............................................................................................................................ 284
AddImage(string) ................................................................................................................... 285
Delete() .................................................................................................................................. 285
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 285
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 285
CriterionConstraint ....................................................................................................................... 286
Criterion ................................................................................................................................. 286
DataModelObjectCategory ..................................................................................................... 287
InitialValue ............................................................................................................................. 287
InternalObject ........................................................................................................................ 287
LowerBound ........................................................................................................................... 287
UpperBound ........................................................................................................................... 287
CrossSection ................................................................................................................................. 287
Children ................................................................................................................................. 288
Comments .............................................................................................................................. 288
DataModelObjectCategory ..................................................................................................... 288
Figures ................................................................................................................................... 289
Images ................................................................................................................................... 289
InternalObject ........................................................................................................................ 289
AddComment() ....................................................................................................................... 289
AddFigure() ............................................................................................................................ 289
AddImage(string) ................................................................................................................... 289
Delete() .................................................................................................................................. 290

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

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


GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 290
CrossSections ............................................................................................................................... 291
Children ................................................................................................................................. 291
Comments .............................................................................................................................. 291
DataModelObjectCategory ..................................................................................................... 291
Figures ................................................................................................................................... 292
Images ................................................................................................................................... 292
InternalObject ........................................................................................................................ 292
AddComment() ....................................................................................................................... 292
AddFigure() ............................................................................................................................ 292
AddImage(string) ................................................................................................................... 292
Delete() .................................................................................................................................. 293
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 293
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 293
CyclicManufacturingConstraint ..................................................................................................... 294
Axis ........................................................................................................................................ 294
CoordinateSystem .................................................................................................................. 294
DataModelObjectCategory ..................................................................................................... 295
InternalObject ........................................................................................................................ 295
Location ................................................................................................................................. 295
NumberofSectors ................................................................................................................... 295
ScopingMethod ...................................................................................................................... 295
CyclicRegion ................................................................................................................................. 295
DataModelObjectCategory ..................................................................................................... 296
InternalObject ........................................................................................................................ 297
FlipHighLow() ......................................................................................................................... 297
DisplacementConstraint ............................................................................................................... 297
DataModelObjectCategory ..................................................................................................... 297
InternalObject ........................................................................................................................ 298
Location ................................................................................................................................. 298
ScopingMethod ...................................................................................................................... 298
XComponentMax .................................................................................................................... 298
YComponentMax .................................................................................................................... 298
ZComponentMax .................................................................................................................... 298
DistributedMass ........................................................................................................................... 299
DataModelObjectCategory ..................................................................................................... 299
InternalObject ........................................................................................................................ 300
MassPerUnitArea .................................................................................................................... 300
MassType ............................................................................................................................... 300
Suppressed ............................................................................................................................ 300
TotalMass ............................................................................................................................... 300
ElementOrientation ...................................................................................................................... 300
AxisEdgeOrientation ............................................................................................................... 301
AxisSurfaceOrientation ........................................................................................................... 301
BodyLocation ......................................................................................................................... 302
Children ................................................................................................................................. 302
Comments .............................................................................................................................. 302
CoordinateSystem .................................................................................................................. 302
DataModelObjectCategory ..................................................................................................... 302
EdgeLocation ......................................................................................................................... 302
Figures ................................................................................................................................... 303

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

Images ................................................................................................................................... 303


InternalObject ........................................................................................................................ 303
OrientationGuideDefinedBy .................................................................................................... 303
Suppressed ............................................................................................................................ 303
SurfaceLocation ...................................................................................................................... 303
AddComment() ....................................................................................................................... 304
AddFigure() ............................................................................................................................ 304
AddImage(string) ................................................................................................................... 304
Delete() .................................................................................................................................. 304
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 304
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 305
EndRelease ................................................................................................................................... 305
Behavior ................................................................................................................................. 306
Children ................................................................................................................................. 306
Comments .............................................................................................................................. 306
CoordinateSystem .................................................................................................................. 307
DataModelObjectCategory ..................................................................................................... 307
EdgeLocation ......................................................................................................................... 307
Figures ................................................................................................................................... 307
Images ................................................................................................................................... 307
IndependentEdges ................................................................................................................. 307
InternalObject ........................................................................................................................ 308
RotationX ............................................................................................................................... 308
RotationY ............................................................................................................................... 308
RotationZ ............................................................................................................................... 308
Suppressed ............................................................................................................................ 308
TranslationX ........................................................................................................................... 308
TranslationY ........................................................................................................................... 309
TranslationZ ........................................................................................................................... 309
VertexLocation ....................................................................................................................... 309
AddComment() ....................................................................................................................... 309
AddFigure() ............................................................................................................................ 309
AddImage(string) ................................................................................................................... 309
Delete() .................................................................................................................................. 310
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 310
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 310
ExclusionRegion ........................................................................................................................... 311
DataModelObjectCategory ..................................................................................................... 311
ExclusionRegionLocation ........................................................................................................ 311
InternalObject ........................................................................................................................ 311
Suppressed ............................................................................................................................ 312
ExpansionSettings ........................................................................................................................ 312
Children ................................................................................................................................. 313
CleanupOptionalFiles .............................................................................................................. 313
Comments .............................................................................................................................. 313
CondensedPartExpansionType ................................................................................................ 313
DataModelObjectCategory ..................................................................................................... 314
ExpandAfterUsePassFailure ..................................................................................................... 314
Figures ................................................................................................................................... 314
GeneralMiscellaneous ............................................................................................................. 314
Images ................................................................................................................................... 314
InternalObject ........................................................................................................................ 314

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

NodalForces ........................................................................................................................... 315


Strain ..................................................................................................................................... 315
Stress ..................................................................................................................................... 315
AddComment() ....................................................................................................................... 315
AddFigure() ............................................................................................................................ 315
AddImage(string) ................................................................................................................... 315
ClearGeneratedData() ............................................................................................................. 316
CreateResultsAtAllSets() .......................................................................................................... 316
Delete() .................................................................................................................................. 316
EvaluateAllResults() ................................................................................................................. 316
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 316
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 317
GetCompletedExpansionState(CondensedPart) ....................................................................... 317
GetExpansionState(CondensedPart) ........................................................................................ 317
PerformExpansionPass() .......................................................................................................... 318
SetExpansionState(CondensedPart, CondensedPartExpansionState) ........................................ 318
ExternalEnhancedModel ............................................................................................................... 318
Children ................................................................................................................................. 319
Comments .............................................................................................................................. 319
DataModelObjectCategory ..................................................................................................... 319
Figures ................................................................................................................................... 319
Images ................................................................................................................................... 320
InternalObject ........................................................................................................................ 320
LayerToDisplay ....................................................................................................................... 320
MaximumNumberOfLayers ..................................................................................................... 320
NonlinearEffects ..................................................................................................................... 320
Suppressed ............................................................................................................................ 320
ThermalStrainEffects ............................................................................................................... 321
Type ....................................................................................................................................... 321
AddComment() ....................................................................................................................... 321
AddFigure() ............................................................................................................................ 321
AddImage(string) ................................................................................................................... 321
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 321
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 322
RegroupToDefault() ................................................................................................................ 322
ExternalModelDataColl ................................................................................................................. 322
Children ................................................................................................................................. 323
Comments .............................................................................................................................. 323
Count ..................................................................................................................................... 323
DataModelObjectCategory ..................................................................................................... 324
Figures ................................................................................................................................... 324
Images ................................................................................................................................... 324
InternalObject ........................................................................................................................ 324
Suppressed ............................................................................................................................ 324
AddComment() ....................................................................................................................... 324
AddFigure() ............................................................................................................................ 325
AddImage(string) ................................................................................................................... 325
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 325
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 325
ExtrusionManufacturingConstraint ............................................................................................... 326
Axis ........................................................................................................................................ 326
CoordinateSystem .................................................................................................................. 327

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

DataModelObjectCategory ..................................................................................................... 327


InternalObject ........................................................................................................................ 327
ScopingMethod ...................................................................................................................... 327
FatigueTool .................................................................................................................................. 327
AnalysisType ........................................................................................................................... 329
BinSize ................................................................................................................................... 329
Children ................................................................................................................................. 329
Comments .............................................................................................................................. 329
DataModelObjectCategory ..................................................................................................... 329
DisplayTime ............................................................................................................................ 329
ExposureDuration ................................................................................................................... 330
FatigueStrengthFactor ............................................................................................................ 330
Frequency .............................................................................................................................. 330
FrequencySelection ................................................................................................................ 330
HistoryDataLocation ............................................................................................................... 330
Images ................................................................................................................................... 330
InfiniteLife .............................................................................................................................. 331
InternalObject ........................................................................................................................ 331
LoadingRatio .......................................................................................................................... 331
LoadingType ........................................................................................................................... 331
MaximumDataPointsToPlot ..................................................................................................... 331
MeanStressTheory .................................................................................................................. 331
MethodSelection .................................................................................................................... 332
OneCycleIsEqualTo ................................................................................................................. 332
ResultsInput ........................................................................................................................... 332
ScaleFactor ............................................................................................................................. 332
StressComponent ................................................................................................................... 332
UnitsName ............................................................................................................................. 332
UseQuickRainflowCounting .................................................................................................... 333
AddBiaxialityIndication() ......................................................................................................... 333
AddComment() ....................................................................................................................... 333
AddDamage() ......................................................................................................................... 333
AddDamageMatrix() ............................................................................................................... 333
AddEquivalentAlternativeStress() ............................................................................................ 333
AddFatigueSensitivity() ........................................................................................................... 334
AddHysteresis() ....................................................................................................................... 334
AddImage(string) ................................................................................................................... 334
AddLife() ................................................................................................................................ 334
AddRainflowMatrix() ............................................................................................................... 334
AddSafetyFactor() ................................................................................................................... 335
Delete() .................................................................................................................................. 335
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 335
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 335
Figure ........................................................................................................................................... 336
Children ................................................................................................................................. 336
Comments .............................................................................................................................. 336
DataModelObjectCategory ..................................................................................................... 336
InternalObject ........................................................................................................................ 337
Text ........................................................................................................................................ 337
AddComment() ....................................................................................................................... 337
Delete() .................................................................................................................................. 337
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 337

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

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 338


Fracture ........................................................................................................................................ 338
Children ................................................................................................................................. 339
Comments .............................................................................................................................. 339
DataModelObjectCategory ..................................................................................................... 339
Figures ................................................................................................................................... 339
Images ................................................................................................................................... 340
InternalObject ........................................................................................................................ 340
AddArbitraryCrack() ................................................................................................................ 340
AddComment() ....................................................................................................................... 340
AddContactDebonding() ........................................................................................................ 340
AddCrack() ***OBSOLETE*** Use the method AddArbitraryCrack or AddSemiEllipticalCrack in-
stead. ..................................................................................................................................... 340
AddFigure() ............................................................................................................................ 341
AddImage(string) ................................................................................................................... 341
AddInterfaceDelamination() .................................................................................................... 341
AddPreMeshedCrack() ............................................................................................................ 341
AddSemiEllipticalCrack() ......................................................................................................... 341
AddSMARTCrackGrowth() ....................................................................................................... 341
Delete() .................................................................................................................................. 342
GenerateAllCrackMesh() ......................................................................................................... 342
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 342
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 342
GeneralAxisymmetric .................................................................................................................... 343
Axis ........................................................................................................................................ 343
Children ................................................................................................................................. 344
Comments .............................................................................................................................. 344
CoordinateSystem .................................................................................................................. 344
DataModelObjectCategory ..................................................................................................... 344
Figures ................................................................................................................................... 344
Images ................................................................................................................................... 344
InternalObject ........................................................................................................................ 345
Location ................................................................................................................................. 345
NodalPlanes ........................................................................................................................... 345
Suppressed ............................................................................................................................ 345
AddComment() ....................................................................................................................... 345
AddFigure() ............................................................................................................................ 345
AddImage(string) ................................................................................................................... 346
Delete() .................................................................................................................................. 346
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 346
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 346
GenericCrack ................................................................................................................................ 347
Children ................................................................................................................................. 347
Comments .............................................................................................................................. 348
DataModelObjectCategory ..................................................................................................... 348
Figures ................................................................................................................................... 348
Images ................................................................................................................................... 348
InternalObject ........................................................................................................................ 348
AddCommandSnippet() .......................................................................................................... 348
AddComment() ....................................................................................................................... 349
AddFigure() ............................................................................................................................ 349
AddImage(string) ................................................................................................................... 349

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

Delete() .................................................................................................................................. 349


GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 349
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 350
GenericDelamination .................................................................................................................... 350
Children ................................................................................................................................. 351
Comments .............................................................................................................................. 351
DataModelObjectCategory ..................................................................................................... 351
Figures ................................................................................................................................... 351
Images ................................................................................................................................... 351
InternalObject ........................................................................................................................ 352
AddCommandSnippet() .......................................................................................................... 352
AddComment() ....................................................................................................................... 352
AddFigure() ............................................................................................................................ 352
AddImage(string) ................................................................................................................... 352
Delete() .................................................................................................................................. 353
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 353
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 353
GenericPointMass ......................................................................................................................... 353
Children ................................................................................................................................. 354
Comments .............................................................................................................................. 354
DataModelObjectCategory ..................................................................................................... 354
Figures ................................................................................................................................... 355
Images ................................................................................................................................... 355
InternalObject ........................................................................................................................ 355
IsDistributedMass ................................................................................................................... 355
Location ................................................................................................................................. 355
RemotePoint .......................................................................................................................... 355
AddComment() ....................................................................................................................... 356
AddFigure() ............................................................................................................................ 356
AddImage(string) ................................................................................................................... 356
Delete() .................................................................................................................................. 356
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 356
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 357
Geometry ..................................................................................................................................... 357
ActiveBodies ........................................................................................................................... 360
AnalysisType ........................................................................................................................... 360
AssignMaterialOnUpdate ........................................................................................................ 360
AttachFileViaTempFile ............................................................................................................ 360
AttributeKey ........................................................................................................................... 360
Attributes ............................................................................................................................... 360
Average .................................................................................................................................. 361
Bodies .................................................................................................................................... 361
CanChangeCADUnits .............................................................................................................. 361
Children ................................................................................................................................. 361
Comments .............................................................................................................................. 361
ComparePartsOnUpdate ......................................................................................................... 361
ComparePartsTolerance .......................................................................................................... 362
DataModelObjectCategory ..................................................................................................... 362
DecomposeDisjointGeometry ................................................................................................. 362
DisplayStyle ............................................................................................................................ 362
ElementControl ...................................................................................................................... 362
Elements ................................................................................................................................ 362

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

EnclosureAndSymmetryProcessing ......................................................................................... 363


EndPlaneRotationAboutX ....................................................................................................... 363
EndPlaneRotationAboutY ....................................................................................................... 363
FiberLength ............................................................................................................................ 363
Figures ................................................................................................................................... 363
GeometryPreferencesReadOnly .............................................................................................. 363
Images ................................................................................................................................... 364
ImportCoordinateSystems ...................................................................................................... 364
InternalObject ........................................................................................................................ 364
LengthUnit ............................................................................................................................. 364
LengthX ................................................................................................................................. 364
LengthY ................................................................................................................................. 364
LengthZ ................................................................................................................................. 365
LineBodies .............................................................................................................................. 365
Mass ....................................................................................................................................... 365
MaterialProperties .................................................................................................................. 365
Maximum ............................................................................................................................... 365
MeshMetric ............................................................................................................................ 365
MeshVolume .......................................................................................................................... 366
Minimum ............................................................................................................................... 366
MixedImportResolution .......................................................................................................... 366
Model2DBehavior ................................................................................................................... 366
NamedSelectionKey ............................................................................................................... 366
NamedSelections .................................................................................................................... 366
Nodes ..................................................................................................................................... 367
ParameterKey ......................................................................................................................... 367
Parameters ............................................................................................................................. 367
ReaderModeSavesUpdatedFile ................................................................................................ 367
ScaleFactorValue ..................................................................................................................... 367
SheetSurfaceArea ................................................................................................................... 367
SmartCADUpdate ................................................................................................................... 368
SolidBodies ............................................................................................................................ 368
Source .................................................................................................................................... 368
StandardDeviation .................................................................................................................. 368
SurfaceArea ............................................................................................................................ 368
SurfaceBodies ......................................................................................................................... 368
TemporaryDirectory ................................................................................................................ 369
Type ....................................................................................................................................... 369
UseAssociativity ...................................................................................................................... 369
UseInstances .......................................................................................................................... 369
Volume ................................................................................................................................... 369
XCentroid ............................................................................................................................... 369
YCentroid ............................................................................................................................... 370
ZCentroid ............................................................................................................................... 370
AddComment() ....................................................................................................................... 370
AddDistributedMass() ............................................................................................................. 370
AddElementOrientation() ........................................................................................................ 370
AddFigure() ............................................................................................................................ 370
AddImage(string) ................................................................................................................... 371
AddLayeredSection() .............................................................................................................. 371
AddPointMass() ...................................................................................................................... 371
AddSurfaceCoating() .............................................................................................................. 371

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

AddThermalPointMass() .......................................................................................................... 371


AddThickness() ....................................................................................................................... 371
GetBody(IBaseGeoBody) ......................................................................................................... 372
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 372
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 372
GetPart(IBaseGeoPart) ............................................................................................................ 373
ResetBodyColors() .................................................................................................................. 373
UpdateGeometryFromSource() ............................................................................................... 373
GlobalVonMisesStressConstraint ................................................................................................... 373
DataModelObjectCategory ..................................................................................................... 374
InternalObject ........................................................................................................................ 374
Maximum ............................................................................................................................... 374
ScopingMethod ...................................................................................................................... 374
Image ........................................................................................................................................... 374
Children ................................................................................................................................. 375
Comments .............................................................................................................................. 375
DataModelObjectCategory ..................................................................................................... 375
Images ................................................................................................................................... 376
InternalObject ........................................................................................................................ 376
AddComment() ....................................................................................................................... 376
AddImage(string) ................................................................................................................... 376
Delete() .................................................................................................................................. 376
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 376
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 377
ImportedBoltPretensions .............................................................................................................. 377
DataModelObjectCategory ..................................................................................................... 378
InternalObject ........................................................................................................................ 378
ImportedConstraintEquations ....................................................................................................... 378
DataModelObjectCategory ..................................................................................................... 379
InternalObject ........................................................................................................................ 379
ImportedContacts ........................................................................................................................ 379
DataModelObjectCategory ..................................................................................................... 380
InternalObject ........................................................................................................................ 380
ImportedCoordinateSystems ........................................................................................................ 381
DataModelObjectCategory ..................................................................................................... 381
InternalObject ........................................................................................................................ 381
ImportedElementOrientations ...................................................................................................... 382
DataModelObjectCategory ..................................................................................................... 382
InternalObject ........................................................................................................................ 383
ImportedFlexibleRemoteConnectors ............................................................................................. 383
DataModelObjectCategory ..................................................................................................... 383
InternalObject ........................................................................................................................ 384
ImportedLayeredSection .............................................................................................................. 384
DataModelObjectCategory ..................................................................................................... 385
InternalObject ........................................................................................................................ 385
ImportedNodalOrientations .......................................................................................................... 385
DataModelObjectCategory ..................................................................................................... 386
InternalObject ........................................................................................................................ 386
ImportedObject ............................................................................................................................ 386
Active ..................................................................................................................................... 387
InternalObject ........................................................................................................................ 387
GetPropertyNames() ............................................................................................................... 387

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

GetPropertyValueAsString(string) ........................................................................................... 387


SetPropertyValue(string, object) .............................................................................................. 388
ImportedPlies ............................................................................................................................... 388
DataModelObjectCategory ..................................................................................................... 389
InternalObject ........................................................................................................................ 389
ImportedPointMasses ................................................................................................................... 389
DataModelObjectCategory ..................................................................................................... 390
InternalObject ........................................................................................................................ 390
ImportedPremeshedBoltPretensions ............................................................................................. 391
DataModelObjectCategory ..................................................................................................... 391
InternalObject ........................................................................................................................ 391
ImportedRigidRemoteConnectors ................................................................................................. 392
DataModelObjectCategory ..................................................................................................... 392
InternalObject ........................................................................................................................ 393
ImportedShellThicknesses ............................................................................................................ 393
DataModelObjectCategory ..................................................................................................... 393
InternalObject ........................................................................................................................ 394
ImportedSpringConnectors .......................................................................................................... 394
DataModelObjectCategory ..................................................................................................... 395
InternalObject ........................................................................................................................ 395
ImportedStresses .......................................................................................................................... 395
DataModelObjectCategory ..................................................................................................... 396
InternalObject ........................................................................................................................ 396
InitialCondition ............................................................................................................................. 396
Children ................................................................................................................................. 398
Comments .............................................................................................................................. 398
ContactStatus ......................................................................................................................... 398
CoordinateSystem .................................................................................................................. 399
DataModelObjectCategory ..................................................................................................... 399
DefineBy ................................................................................................................................ 399
Direction ................................................................................................................................ 399
DropDirection ........................................................................................................................ 399
DropHeight ............................................................................................................................ 399
DropTestDefineBy ................................................................................................................... 400
ExplicitPreStressTime .............................................................................................................. 400
Figures ................................................................................................................................... 400
Images ................................................................................................................................... 400
ImpactVelocity ........................................................................................................................ 400
InitialEnvironment .................................................................................................................. 400
InitialTemperature .................................................................................................................. 401
InitialTemperatureValue .......................................................................................................... 401
InputType ............................................................................................................................... 401
InternalObject ........................................................................................................................ 401
Location ................................................................................................................................. 401
ModalEnvironmentHarmonicIC ***OBSOLETE*** Use 'ModalICEnvironment' property in-
stead. ..................................................................................................................................... 401
ModalEnvironmentPSDIC ***OBSOLETE*** Use 'ModalICEnvironment' property instead. .......... 402
ModalEnvironmentRSIC ***OBSOLETE*** Use 'ModalICEnvironment' property instead. ............ 402
ModalEnvironmentTransientMSUPIC ***OBSOLETE*** Use 'ModalICEnvironment' property in-
stead. ..................................................................................................................................... 402
ModalICEnvironment .............................................................................................................. 402
Mode ..................................................................................................................................... 402

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

NewtonRaphsonOption .......................................................................................................... 403


PressureInitialization ............................................................................................................... 403
PreStressDefineBy ................................................................................................................... 403
PreStressEnvironmentHarmonicIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 403
PreStressEnvironmentHarmonicMSUPModal ........................................................................... 403
PreStressEnvironmentModalIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 403
PreStressEnvironmentTransientIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 404
PreStressEnvironmentTransientMSUPModal ............................................................................ 404
PreStressICEnvironment .......................................................................................................... 404
PreStressLoadStep .................................................................................................................. 404
PreStressTime ......................................................................................................................... 404
ReferenceTemperature ............................................................................................................ 404
ReportedLoadStep .................................................................................................................. 405
ReportedSubStep ................................................................................................................... 405
ReportedTime ........................................................................................................................ 405
Suppressed ............................................................................................................................ 405
Time ....................................................................................................................................... 405
TimeStepFactor ...................................................................................................................... 405
TotalMagnitude ...................................................................................................................... 406
XComponent .......................................................................................................................... 406
YComponent .......................................................................................................................... 406
ZComponent .......................................................................................................................... 406
AddCommandSnippet() .......................................................................................................... 406
AddComment() ....................................................................................................................... 406
AddFigure() ............................................................................................................................ 407
AddImage(string) ................................................................................................................... 407
Delete() .................................................................................................................................. 407
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 407
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 408
InitialConditions ........................................................................................................................... 408
Children ................................................................................................................................. 409
Comments .............................................................................................................................. 409
DataModelObjectCategory ..................................................................................................... 409
Figures ................................................................................................................................... 409
Images ................................................................................................................................... 409
InternalObject ........................................................................................................................ 409
AddComment() ....................................................................................................................... 410
AddFigure() ............................................................................................................................ 410
AddImage(string) ................................................................................................................... 410
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 410
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 411
InsertAngularVelocity() ........................................................................................................... 411
InsertDropHeight() ................................................................................................................. 411
InsertVelocity() ....................................................................................................................... 411
InterfaceDelamination .................................................................................................................. 411
AutomaticTimeStepping ......................................................................................................... 412
CriticalRate ............................................................................................................................. 413
DataModelObjectCategory ..................................................................................................... 413
DistanceTolerance .................................................................................................................. 413

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

FailureCriteriaOption .............................................................................................................. 413


GenerationMethod ................................................................................................................. 413
InitialCrack ............................................................................................................................. 413
InitialTimeStep ....................................................................................................................... 414
InternalObject ........................................................................................................................ 414
MatchControl ......................................................................................................................... 414
Material .................................................................................................................................. 414
MaximumTimeStep ................................................................................................................ 414
Method .................................................................................................................................. 414
MinimumTimeStep ................................................................................................................. 415
SourceLocation ....................................................................................................................... 415
Suppressed ............................................................................................................................ 415
TargetLocation ....................................................................................................................... 415
ToleranceType ........................................................................................................................ 415
Type ....................................................................................................................................... 415
JointBushingWorksheet ................................................................................................................ 416
GetBushingDampingPerThetaUnitX(int) .................................................................................. 417
GetBushingDampingPerThetaUnitY(int) .................................................................................. 417
GetBushingDampingPerThetaUnitZ(int) .................................................................................. 417
GetBushingDampingPerUnitX(int) .......................................................................................... 418
GetBushingDampingPerUnitY(int) ........................................................................................... 418
GetBushingDampingPerUnitZ(int) ........................................................................................... 418
GetBushingStiffnessPerThetaUnitX(int) ................................................................................... 419
GetBushingStiffnessPerThetaUnitY(int) ................................................................................... 419
GetBushingStiffnessPerThetaUnitZ(int) ................................................................................... 419
GetBushingStiffnessPerUnitX(int) ............................................................................................ 419
GetBushingStiffnessPerUnitY(int) ............................................................................................ 420
GetBushingStiffnessPerUnitZ(int) ............................................................................................ 420
SetBushingDampingPerThetaUnitX(int, double) ...................................................................... 420
SetBushingDampingPerThetaUnitY(int, double) ...................................................................... 420
SetBushingDampingPerThetaUnitZ(int, double) ...................................................................... 421
SetBushingDampingPerUnitX(int, double) ............................................................................... 421
SetBushingDampingPerUnitY(int, double) ............................................................................... 421
SetBushingDampingPerUnitZ(int, double) ............................................................................... 422
SetBushingStiffnessPerThetaUnitX(int, double) ........................................................................ 422
SetBushingStiffnessPerThetaUnitY(int, double) ........................................................................ 422
SetBushingStiffnessPerThetaUnitZ(int, double) ........................................................................ 423
SetBushingStiffnessPerUnitX(int, double) ................................................................................ 423
SetBushingStiffnessPerUnitY(int, double) ................................................................................. 423
SetBushingStiffnessPerUnitZ(int, double) ................................................................................ 424
LayeredSection ............................................................................................................................. 424
Children ................................................................................................................................. 425
Comments .............................................................................................................................. 425
CoordinateSystem .................................................................................................................. 425
DataModelObjectCategory ..................................................................................................... 426
Figures ................................................................................................................................... 426
Images ................................................................................................................................... 426
InternalObject ........................................................................................................................ 426
LayeredSectionMembraneOffset ............................................................................................. 426
Layers ..................................................................................................................................... 426
LayerToDisplay ....................................................................................................................... 427
Location ................................................................................................................................. 427

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

NonlinearEffects ..................................................................................................................... 427


OffsetType .............................................................................................................................. 427
Suppressed ............................................................................................................................ 427
ThermalStrainEffects ............................................................................................................... 427
TotalMass ............................................................................................................................... 428
TotalThickness ........................................................................................................................ 428
AddComment() ....................................................................................................................... 428
AddFigure() ............................................................................................................................ 428
AddImage(string) ................................................................................................................... 428
Delete() .................................................................................................................................. 428
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 429
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 429
LayeredSectionWorksheet ............................................................................................................ 429
RowCount .............................................................................................................................. 430
AddThicknessLayer(string, double, double) .............................................................................. 431
DeleteRow(int) ....................................................................................................................... 431
GetAngle(int) .......................................................................................................................... 431
GetMaterial(int) ...................................................................................................................... 432
GetThickness(int) .................................................................................................................... 432
InsertThicknessLayerAbove(string, double, double, int) ............................................................ 432
InsertThicknessLayerBelow(string, double, double, int) ............................................................. 433
SetAngle(int, double) .............................................................................................................. 433
SetMaterial(int, string) ............................................................................................................. 433
SetThickness(int, double) ........................................................................................................ 434
LocalVonMisesStressConstraint ..................................................................................................... 434
DataModelObjectCategory ..................................................................................................... 435
InternalObject ........................................................................................................................ 435
Location ................................................................................................................................. 435
Maximum ............................................................................................................................... 435
ScopingMethod ...................................................................................................................... 435
ManufacturingConstraint .............................................................................................................. 435
Children ................................................................................................................................. 436
DataModelObjectCategory ..................................................................................................... 436
InternalObject ........................................................................................................................ 436
Selection ................................................................................................................................ 436
Suppressed ............................................................................................................................ 437
Delete() .................................................................................................................................. 437
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 437
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 437
MassConstraint ............................................................................................................................. 438
DataModelObjectCategory ..................................................................................................... 438
DefineBy ................................................................................................................................ 438
InternalObject ........................................................................................................................ 439
PercentageToRetain ................................................................................................................ 439
PercentageToRetainMax ......................................................................................................... 439
PercentageToRetainMin .......................................................................................................... 439
ScopingMethod ...................................................................................................................... 439
Material ........................................................................................................................................ 439
AssignedBodies ...................................................................................................................... 440
Children ................................................................................................................................. 440
Comments .............................................................................................................................. 440
DataModelObjectCategory ..................................................................................................... 441

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

Figures ................................................................................................................................... 441


Images ................................................................................................................................... 441
InternalObject ........................................................................................................................ 441
AddComment() ....................................................................................................................... 441
AddFigure() ............................................................................................................................ 441
AddImage(string) ................................................................................................................... 442
CreateMaterialAssignment() .................................................................................................... 442
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 442
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 442
MaterialAssignment ...................................................................................................................... 443
Children ................................................................................................................................. 444
Comments .............................................................................................................................. 444
DataModelObjectCategory ..................................................................................................... 444
FieldCoordinateSystem ........................................................................................................... 444
Figures ................................................................................................................................... 444
Images ................................................................................................................................... 445
InternalObject ........................................................................................................................ 445
Location ................................................................................................................................. 445
Material .................................................................................................................................. 445
MaterialName ***OBSOLETE*** Use 'Material' property instead. ............................................... 445
NonlinearEffects ..................................................................................................................... 445
ReadOnly ................................................................................................................................ 446
ReferenceTemperatureValue ................................................................................................... 446
Suppressed ............................................................................................................................ 446
ThermalStrainEffects ............................................................................................................... 446
UseReferenceTemperatureByBody .......................................................................................... 446
AddCommandSnippet() .......................................................................................................... 446
AddComment() ....................................................................................................................... 447
AddFigure() ............................................................................................................................ 447
AddImage(string) ................................................................................................................... 447
Delete() .................................................................................................................................. 447
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 447
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 448
MaterialPlot .................................................................................................................................. 448
Children ................................................................................................................................. 449
DataModelObjectCategory ..................................................................................................... 449
InternalObject ........................................................................................................................ 449
Location ................................................................................................................................. 449
MaterialProperty ..................................................................................................................... 449
MaterialPropertyComponent .................................................................................................. 450
Suppressed ............................................................................................................................ 450
Clear() .................................................................................................................................... 450
Delete() .................................................................................................................................. 450
Generate() .............................................................................................................................. 450
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 450
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 451
Materials ...................................................................................................................................... 451
Children ................................................................................................................................. 452
Comments .............................................................................................................................. 452
DataModelObjectCategory ..................................................................................................... 452
Figures ................................................................................................................................... 452
Images ................................................................................................................................... 453

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

InternalObject ........................................................................................................................ 453


MaterialAssignments .............................................................................................................. 453
MaterialCount ......................................................................................................................... 453
AddComment() ....................................................................................................................... 453
AddFigure() ............................................................................................................................ 453
AddImage(string) ................................................................................................................... 454
AddMaterialAssignment() ....................................................................................................... 454
AddMaterialCombination() ..................................................................................................... 454
AddMaterialPlot() ................................................................................................................... 454
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 454
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 455
RefreshMaterials() ................................................................................................................... 455
MemberSizeManufacturingConstraint ........................................................................................... 455
DataModelObjectCategory ..................................................................................................... 456
InternalObject ........................................................................................................................ 456
Maximum ............................................................................................................................... 456
MaxSize .................................................................................................................................. 457
Minimum ............................................................................................................................... 457
MinSize .................................................................................................................................. 457
ScopingMethod ...................................................................................................................... 457
MeshConnection .......................................................................................................................... 457
ContactRegion ........................................................................................................................ 459
DataModelObjectCategory ..................................................................................................... 459
InternalObject ........................................................................................................................ 459
MasterElementSizeFactor ........................................................................................................ 459
ThicknessScaleFactor .............................................................................................................. 460
ToleranceValue ....................................................................................................................... 460
MeshConnectionBase ................................................................................................................... 460
Children ................................................................................................................................. 461
Comments .............................................................................................................................. 461
DataModelObjectCategory ..................................................................................................... 461
Figures ................................................................................................................................... 461
Images ................................................................................................................................... 462
InternalObject ........................................................................................................................ 462
MasterBodies .......................................................................................................................... 462
MasterLocation ....................................................................................................................... 462
ScopeMode ............................................................................................................................ 462
ScopingMethod ...................................................................................................................... 462
SlaveBodies ............................................................................................................................ 463
SlaveLocation ......................................................................................................................... 463
SnapToBoundary .................................................................................................................... 463
SnapTolerance ........................................................................................................................ 463
SnapType ............................................................................................................................... 463
Suppressed ............................................................................................................................ 463
ToleranceSlider ....................................................................................................................... 464
ToleranceType ........................................................................................................................ 464
AddComment() ....................................................................................................................... 464
AddFigure() ............................................................................................................................ 464
AddImage(string) ................................................................................................................... 464
Delete() .................................................................................................................................. 465
Generate() .............................................................................................................................. 465
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 465

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

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 465


MeshConnectionGroup ................................................................................................................. 466
DataModelObjectCategory ..................................................................................................... 468
InternalObject ........................................................................................................................ 468
AddManualMeshConnection() ................................................................................................ 468
DetectConnections() ............................................................................................................... 468
Generate() .............................................................................................................................. 468
MeshControlWorksheet ................................................................................................................ 469
RowCount .............................................................................................................................. 469
AddRow() ............................................................................................................................... 469
ClearGenerateMesh() .............................................................................................................. 469
DeleteAllRows() ...................................................................................................................... 470
DeleteRow(int) ....................................................................................................................... 470
GenerateAtRow(int) ................................................................................................................ 470
GenerateMesh() ...................................................................................................................... 470
GetActiveState(int) ................................................................................................................. 470
GetNamedSelection(int) ......................................................................................................... 471
GetNamedSelectionId(int) ...................................................................................................... 471
SetActiveState(int, bool) .......................................................................................................... 471
SetNamedSelection(int, NamedSelection) ............................................................................... 472
SetNamedSelectionId(int, uint) ................................................................................................ 472
MeshEdit ...................................................................................................................................... 472
Children ................................................................................................................................. 473
Comments .............................................................................................................................. 473
DataModelObjectCategory ..................................................................................................... 474
Figures ................................................................................................................................... 474
GenerateAutomaticMeshConnectionsOnRefresh ..................................................................... 474
Images ................................................................................................................................... 474
InternalObject ........................................................................................................................ 474
TransparencyEnabled ............................................................................................................. 474
AddComment() ....................................................................................................................... 475
AddContactMatchGroup() ....................................................................................................... 475
AddFigure() ............................................................................................................................ 475
AddImage(string) ................................................................................................................... 475
AddManualMeshConnection() ................................................................................................ 475
AddMeshConnectionGroup() .................................................................................................. 475
AddNodeMerge() .................................................................................................................... 476
AddNodeMergeGroup() .......................................................................................................... 476
AddNodeMove() ..................................................................................................................... 476
ClearGeneratedData() ............................................................................................................. 476
CreateNamedSelectionForSharedNodes() ................................................................................ 476
Generate() .............................................................................................................................. 476
GenerateAllMeshEdits() ........................................................................................................... 477
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 477
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 477
SearchConnectionsForDuplicatePairs() .................................................................................... 478
MeshNumbering .......................................................................................................................... 478
Children ................................................................................................................................. 478
Comments .............................................................................................................................. 479
CompressNodeNumbers ......................................................................................................... 479
DataModelObjectCategory ..................................................................................................... 479
ElementOffset ........................................................................................................................ 479

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

Figures ................................................................................................................................... 479


Images ................................................................................................................................... 479
InternalObject ........................................................................................................................ 480
NodeOffset ............................................................................................................................. 480
Suppressed ............................................................................................................................ 480
AddComment() ....................................................................................................................... 480
AddFigure() ............................................................................................................................ 480
AddImage(string) ................................................................................................................... 480
AddNumberingControl() ......................................................................................................... 481
Delete() .................................................................................................................................. 481
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 481
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 481
RenumberMesh() .................................................................................................................... 482
Model ........................................................................................................................................... 482
Ambient ................................................................................................................................. 484
AMProcess .............................................................................................................................. 485
Analyses ................................................................................................................................. 485
CellId ...................................................................................................................................... 485
Children ................................................................................................................................. 485
Color ...................................................................................................................................... 485
Comments .............................................................................................................................. 485
CondensedGeometry .............................................................................................................. 486
Connections ........................................................................................................................... 486
ConstructionGeometry ........................................................................................................... 486
Control ................................................................................................................................... 486
CoordinateSystems ................................................................................................................. 486
DataModelObjectCategory ..................................................................................................... 486
Diffuse .................................................................................................................................... 487
Environments ***OBSOLETE*** Use 'Analyses' property instead. .............................................. 487
Figures ................................................................................................................................... 487
Fracture .................................................................................................................................. 487
Geometry ............................................................................................................................... 487
Images ................................................................................................................................... 487
InternalObject ........................................................................................................................ 488
Materials ................................................................................................................................ 488
Mesh ...................................................................................................................................... 488
MeshEdit ................................................................................................................................ 488
MeshNumbering .................................................................................................................... 488
NamedSelections .................................................................................................................... 488
PartTransformGroup ............................................................................................................... 489
RemotePoints ......................................................................................................................... 489
Specular ................................................................................................................................. 489
Symmetry ............................................................................................................................... 489
SystemCaption ....................................................................................................................... 489
VirtualTopology ...................................................................................................................... 489
AddAMProcess() ..................................................................................................................... 490
AddChart() ............................................................................................................................. 490
AddComment() ....................................................................................................................... 490
AddCondensedGeometry() ..................................................................................................... 490
AddConnections() ................................................................................................................... 490
AddConstructionGeometry() ................................................................................................... 490
AddCoupledFieldStatic() ......................................................................................................... 491

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

AddCoupledFieldTransient() .................................................................................................... 491


AddDesignAssessmentAnalysis() ............................................................................................. 491
AddEigenvalueBucklingAnalysis() ............................................................................................ 491
AddElectricAnalysis() .............................................................................................................. 491
AddExplicitDynamicsAnalysis() ............................................................................................... 491
AddFigure() ............................................................................................................................ 492
AddFracture() ......................................................................................................................... 492
AddHarmonicAcousticAnalysis() .............................................................................................. 492
AddHarmonicResponseAnalysis() ............................................................................................ 492
AddImage(string) ................................................................................................................... 492
AddMagnetostaticAnalysis() .................................................................................................... 492
AddMeshEdit() ........................................................................................................................ 493
AddMeshNumbering() ............................................................................................................ 493
AddModalAcousticAnalysis() ................................................................................................... 493
AddModalAnalysis() ................................................................................................................ 493
AddNamedSelection() ............................................................................................................. 493
AddPartTransform() ................................................................................................................ 493
AddRandomVibrationAnalysis() .............................................................................................. 494
AddRemotePoint() .................................................................................................................. 494
AddResponseSpectrumAnalysis() ............................................................................................ 494
AddRigidDynamicsAnalysis() ................................................................................................... 494
AddSolutionCombination() ..................................................................................................... 494
AddStaticAcousticAnalysis() .................................................................................................... 494
AddStaticStructuralAnalysis() .................................................................................................. 495
AddSteadyStateThermalAnalysis() ........................................................................................... 495
AddSymmetry() ...................................................................................................................... 495
AddThermalElectricAnalysis() .................................................................................................. 495
AddTopologyOptimizationAnalysis() ....................................................................................... 495
AddTransientStructuralAnalysis() ............................................................................................. 495
AddTransientThermalAnalysis() ............................................................................................... 496
AddVirtualTopology() ............................................................................................................. 496
ClearGeneratedData() ............................................................................................................. 496
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 496
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 496
GetFECommandsRepository(string, string) .............................................................................. 497
GetResults() ............................................................................................................................ 497
RefreshMaterials() ................................................................................................................... 497
Solve(bool, SolveConfiguration) .............................................................................................. 498
Solve(bool, string) ................................................................................................................... 498
UpdateGeometryFromSource() ............................................................................................... 498
MomentOfInertiaConstraint .......................................................................................................... 498
Axis ........................................................................................................................................ 499
CoordinateSystem .................................................................................................................. 499
DataModelObjectCategory ..................................................................................................... 499
InternalObject ........................................................................................................................ 499
PercentageToRetainMax ......................................................................................................... 500
PercentageToRetainMin .......................................................................................................... 500
Suppressed ............................................................................................................................ 500
Delete() .................................................................................................................................. 500
NamedSelection ........................................................................................................................... 500
Children ................................................................................................................................. 501
Comments .............................................................................................................................. 502

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

DataModelObjectCategory ..................................................................................................... 502


Figures ................................................................................................................................... 502
GenerationCriteria .................................................................................................................. 502
Images ................................................................................................................................... 502
IncludeProgramControlledInflation ......................................................................................... 502
InternalObject ........................................................................................................................ 503
Location ***OBSOLETE*** Use the GenerationCriteria property to alter worksheet data in-
stead. ..................................................................................................................................... 503
RelativeTolerance .................................................................................................................... 503
ScopingMethod ...................................................................................................................... 503
SendAs ................................................................................................................................... 503
SendToSolver ......................................................................................................................... 503
Suppressed ............................................................................................................................ 504
ToleranceType ........................................................................................................................ 504
TotalSelection ......................................................................................................................... 504
Type ....................................................................................................................................... 504
UsedByMeshWorksheet .......................................................................................................... 504
Visible .................................................................................................................................... 504
ZeroTolerance ......................................................................................................................... 505
AddComment() ....................................................................................................................... 505
AddFigure() ............................................................................................................................ 505
AddImage(string) ................................................................................................................... 505
Delete() .................................................................................................................................. 505
ExportNamedSelectionToCDBFile(string) ................................................................................. 505
ExportToTextFile(string) .......................................................................................................... 506
Generate() .............................................................................................................................. 506
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 506
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 506
NamedSelectionCriteria ................................................................................................................ 507
Count ..................................................................................................................................... 507
Item(int) ................................................................................................................................. 508
Add(NamedSelectionCriterion) ............................................................................................... 508
Clear() .................................................................................................................................... 508
Contains(NamedSelectionCriterion) ........................................................................................ 508
IndexOf(NamedSelectionCriterion) ......................................................................................... 508
Insert(int, NamedSelectionCriterion) ........................................................................................ 509
Remove(NamedSelectionCriterion) ......................................................................................... 509
RemoveAt(int) ........................................................................................................................ 509
NamedSelectionCriterion .............................................................................................................. 510
NamedSelectionCriterion(bool, SelectionActionType, SelectionType, SelectionCriterionType,
SelectionOperatorType, object, Quantity, Quantity, CoordinateSystem) ..................................... 510
Action .................................................................................................................................... 511
Active ..................................................................................................................................... 511
CoordinateSystem .................................................................................................................. 511
Criterion ................................................................................................................................. 511
EntityType .............................................................................................................................. 512
LowerBound ........................................................................................................................... 512
Operator ................................................................................................................................. 512
UpperBound ........................................................................................................................... 512
Value ...................................................................................................................................... 512
NamedSelections .......................................................................................................................... 512
Children ................................................................................................................................. 513

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

Comments .............................................................................................................................. 513


DataModelObjectCategory ..................................................................................................... 514
Figures ................................................................................................................................... 514
GenerateOnRefresh ................................................................................................................ 514
GenerateOnRemesh ............................................................................................................... 514
Images ................................................................................................................................... 514
InternalObject ........................................................................................................................ 514
RandomColors ........................................................................................................................ 515
ShowAnnotations ................................................................................................................... 515
AddComment() ....................................................................................................................... 515
AddFigure() ............................................................................................................................ 515
AddImage(string) ................................................................................................................... 515
AddNamedSelection() ............................................................................................................. 515
Delete() .................................................................................................................................. 516
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 516
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 516
NastranExportOptions .................................................................................................................. 517
NastranExportOptions(string, string, int, int, double, double, string, int, double, bool) ................. 517
AnalysisType ........................................................................................................................... 518
GridCS .................................................................................................................................... 518
GroundCheck ......................................................................................................................... 518
JointStiffness .......................................................................................................................... 518
Modes .................................................................................................................................... 519
NastranFilename ..................................................................................................................... 519
Offset ..................................................................................................................................... 519
PyramidElements .................................................................................................................... 519
Time ....................................................................................................................................... 519
WTMass .................................................................................................................................. 519
NaturalFrequencyConstraint ......................................................................................................... 520
DataModelObjectCategory ..................................................................................................... 520
InternalObject ........................................................................................................................ 520
MaximumFrequency ............................................................................................................... 520
MinimumFrequency ............................................................................................................... 521
ModeNumber ......................................................................................................................... 521
NodeMerge .................................................................................................................................. 521
Children ................................................................................................................................. 522
Comments .............................................................................................................................. 522
DataModelObjectCategory ..................................................................................................... 522
Figures ................................................................................................................................... 522
Images ................................................................................................................................... 522
InternalObject ........................................................................................................................ 523
MasterBodies .......................................................................................................................... 523
MasterLocation ....................................................................................................................... 523
ScopingMethod ...................................................................................................................... 523
SlaveBodies ............................................................................................................................ 523
SlaveLocation ......................................................................................................................... 523
Suppressed ............................................................................................................................ 524
ToleranceType ........................................................................................................................ 524
ToleranceValue ....................................................................................................................... 524
AddComment() ....................................................................................................................... 524
AddFigure() ............................................................................................................................ 524
AddImage(string) ................................................................................................................... 524

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

Delete() .................................................................................................................................. 525


Generate() .............................................................................................................................. 525
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 525
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 525
NodeMergeGroup ........................................................................................................................ 526
DataModelObjectCategory ..................................................................................................... 528
InternalObject ........................................................................................................................ 528
AddNodeMerge() .................................................................................................................... 528
GenerateNodeMerge() ............................................................................................................ 528
NodeMove ................................................................................................................................... 529
Children ................................................................................................................................. 529
Comments .............................................................................................................................. 530
DataModelObjectCategory ..................................................................................................... 530
Figures ................................................................................................................................... 530
Images ................................................................................................................................... 530
Information ............................................................................................................................ 530
InternalObject ........................................................................................................................ 530
NumberOfMoves .................................................................................................................... 531
NumberOfNodes .................................................................................................................... 531
AddComment() ....................................................................................................................... 531
AddFigure() ............................................................................................................................ 531
AddImage(string) ................................................................................................................... 531
Delete() .................................................................................................................................. 531
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 532
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 532
MoveNode(int, Quantity, Quantity, Quantity) ............................................................................ 532
UndoAllNodeMoves() ............................................................................................................. 533
UndoLastNodeMove() ............................................................................................................. 533
NumberingControl ....................................................................................................................... 533
BeginElementNumber ............................................................................................................ 534
BeginNodeNumber ................................................................................................................. 534
Children ................................................................................................................................. 534
Comments .............................................................................................................................. 534
DataModelObjectCategory ..................................................................................................... 535
EndElementNumber ............................................................................................................... 535
EndNodeNumber ................................................................................................................... 535
Figures ................................................................................................................................... 535
Images ................................................................................................................................... 535
InternalObject ........................................................................................................................ 535
Location ................................................................................................................................. 536
NodeNumber ......................................................................................................................... 536
Suppressed ............................................................................................................................ 536
AddComment() ....................................................................................................................... 536
AddFigure() ............................................................................................................................ 536
AddImage(string) ................................................................................................................... 536
Delete() .................................................................................................................................. 537
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 537
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 537
Objective ...................................................................................................................................... 538
Children ................................................................................................................................. 538
Comments .............................................................................................................................. 538
DataModelObjectCategory ..................................................................................................... 539

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

Images ................................................................................................................................... 539


InternalObject ........................................................................................................................ 539
Suppressed ............................................................................................................................ 539
Worksheet .............................................................................................................................. 539
AddComment() ....................................................................................................................... 539
AddImage(string) ................................................................................................................... 540
Delete() .................................................................................................................................. 540
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 540
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 540
ObjectiveWorksheet ..................................................................................................................... 541
RowCount .............................................................................................................................. 542
AddRow() ............................................................................................................................... 542
DeleteRow(int) ....................................................................................................................... 542
GetEnabled(int) ...................................................................................................................... 542
GetEndMode(int) .................................................................................................................... 543
GetEndStep(int) ...................................................................................................................... 543
GetEnvironment(int) ............................................................................................................... 543
GetFormulation(int) ................................................................................................................ 544
GetMode(int) .......................................................................................................................... 544
GetMultipleSets(int) ................................................................................................................ 544
GetObjectiveType(int) ............................................................................................................. 544
GetStartMode(int) ................................................................................................................... 545
GetStartStep(int) .................................................................................................................... 545
GetStep(int) ............................................................................................................................ 545
GetWeight(int) ........................................................................................................................ 545
SetEnabled(int, bool) ............................................................................................................... 546
SetEndMode(int, int) ............................................................................................................... 546
SetEndStep(int, int) ................................................................................................................. 546
SetEnvironment(int, Analysis) .................................................................................................. 547
SetFormulation(int, TopoObjectiveFormulation) ...................................................................... 547
SetMode(int, int) ..................................................................................................................... 547
SetMultipleSets(int, bool) ........................................................................................................ 548
SetObjectiveType(int, ObjectiveType) ...................................................................................... 548
SetStartMode(int, int) .............................................................................................................. 548
SetStartStep(int, int) ................................................................................................................ 549
SetStep(int, int) ....................................................................................................................... 549
SetWeight(int, double) ............................................................................................................ 549
OptimizationRegion ..................................................................................................................... 550
BoundaryCondition ................................................................................................................ 550
DataModelObjectCategory ..................................................................................................... 550
DesignRegionLocation ............................................................................................................ 551
ExclusionRegionLocation ........................................................................................................ 551
InternalObject ........................................................................................................................ 551
LatticeMaxDensity .................................................................................................................. 551
LatticeMinDensity ................................................................................................................... 551
LatticeSize .............................................................................................................................. 551
LatticeType ............................................................................................................................. 552
OptimizationType ................................................................................................................... 552
AddExclusionRegion() ............................................................................................................. 552
OptimizationRegionBaseClass ....................................................................................................... 552
Children ................................................................................................................................. 553
InternalObject ........................................................................................................................ 553

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

Delete() .................................................................................................................................. 553


GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 553
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 553
Part .............................................................................................................................................. 554
ApproximateSurfaceArea ........................................................................................................ 555
Assignment ***OBSOLETE*** Use 'Material' property instead. .................................................. 555
Average .................................................................................................................................. 556
CentroidX ............................................................................................................................... 556
CentroidY ............................................................................................................................... 556
CentroidZ ............................................................................................................................... 556
Children ................................................................................................................................. 556
Comments .............................................................................................................................. 556
CoordinateSystem .................................................................................................................. 557
DataModelObjectCategory ..................................................................................................... 557
Elements ................................................................................................................................ 557
Figures ................................................................................................................................... 557
Hidden ................................................................................................................................... 557
Images ................................................................................................................................... 557
InternalObject ........................................................................................................................ 558
LengthX ................................................................................................................................. 558
LengthY ................................................................................................................................. 558
LengthZ ................................................................................................................................. 558
Mass ....................................................................................................................................... 558
Material .................................................................................................................................. 558
MaterialName ***OBSOLETE*** Use 'Assignment' property instead. ......................................... 559
Maximum ............................................................................................................................... 559
MeshMetric ............................................................................................................................ 559
Minimum ............................................................................................................................... 559
MomentOfInertiaIp1 ............................................................................................................... 559
MomentOfInertiaIp2 ............................................................................................................... 559
MomentOfInertiaIp3 ............................................................................................................... 560
Nodes ..................................................................................................................................... 560
StandardDeviation .................................................................................................................. 560
Suppressed ............................................................................................................................ 560
Visible .................................................................................................................................... 560
Volume ................................................................................................................................... 560
AddComment() ....................................................................................................................... 561
AddFigure() ............................................................................................................................ 561
AddImage(string) ................................................................................................................... 561
ClearGeneratedData() ............................................................................................................. 561
GenerateMesh() ...................................................................................................................... 561
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 561
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 562
PreviewInflation() ................................................................................................................... 562
PreviewSurfaceMesh() ............................................................................................................ 562
Update() ................................................................................................................................. 563
PartTransform ............................................................................................................................... 563
Children ................................................................................................................................. 564
Comments .............................................................................................................................. 564
CoordinateSystem .................................................................................................................. 564
DataModelObjectCategory ..................................................................................................... 564
DefineBy ................................................................................................................................ 564

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

Figures ................................................................................................................................... 565


Images ................................................................................................................................... 565
InternalObject ........................................................................................................................ 565
Location ................................................................................................................................. 565
Parts ....................................................................................................................................... 565
RotationX ............................................................................................................................... 565
RotationY ............................................................................................................................... 566
RotationZ ............................................................................................................................... 566
ScopingMethod ...................................................................................................................... 566
SourceCoordinateSystem ........................................................................................................ 566
Suppressed ............................................................................................................................ 566
TargetCoordinateSystem ......................................................................................................... 566
TranslationX ........................................................................................................................... 567
TranslationY ........................................................................................................................... 567
TranslationZ ........................................................................................................................... 567
AddComment() ....................................................................................................................... 567
AddFigure() ............................................................................................................................ 567
AddImage(string) ................................................................................................................... 567
Delete() .................................................................................................................................. 568
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 568
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 568
TransformGeometry() ............................................................................................................. 569
PartTransformGroup ..................................................................................................................... 569
Children ................................................................................................................................. 569
Comments .............................................................................................................................. 570
DataModelObjectCategory ..................................................................................................... 570
Figures ................................................................................................................................... 570
Images ................................................................................................................................... 570
InternalObject ........................................................................................................................ 570
RegenerateContacts ............................................................................................................... 570
Suppressed ............................................................................................................................ 571
TransformMesh ....................................................................................................................... 571
AddComment() ....................................................................................................................... 571
AddFigure() ............................................................................................................................ 571
AddImage(string) ................................................................................................................... 571
AddPartTransform() ................................................................................................................ 572
Delete() .................................................................................................................................. 572
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 572
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 572
TransformGeometry() ............................................................................................................. 573
Path ............................................................................................................................................. 573
Children ................................................................................................................................. 574
Comments .............................................................................................................................. 574
DataModelObjectCategory ..................................................................................................... 574
EndCoordinateSystem ............................................................................................................ 574
EndXCoordinate ..................................................................................................................... 574
EndYCoordinate ...................................................................................................................... 575
EndZCoordinate ..................................................................................................................... 575
Figures ................................................................................................................................... 575
HasValidGeometrySelection .................................................................................................... 575
Images ................................................................................................................................... 575
InternalObject ........................................................................................................................ 575

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

Location ................................................................................................................................. 576


NumberOfSamplingPoints ...................................................................................................... 576
PathCoordinateSystem ........................................................................................................... 576
PathType ................................................................................................................................ 576
ShowMesh ............................................................................................................................. 576
SnapToMeshNodes ................................................................................................................. 576
StartCoordinateSystem ........................................................................................................... 577
StartXCoordinate .................................................................................................................... 577
StartYCoordinate .................................................................................................................... 577
StartZCoordinate .................................................................................................................... 577
Suppressed ............................................................................................................................ 577
AddComment() ....................................................................................................................... 577
AddFigure() ............................................................................................................................ 578
AddImage(string) ................................................................................................................... 578
Delete() .................................................................................................................................. 578
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 578
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 579
PeriodicRegion ............................................................................................................................. 579
DataModelObjectCategory ..................................................................................................... 580
InternalObject ........................................................................................................................ 580
Type ....................................................................................................................................... 580
PhysicsRegion .............................................................................................................................. 580
Acoustics ................................................................................................................................ 582
ArtificiallyMatchedLayers ........................................................................................................ 582
Children ................................................................................................................................. 582
DataModelObjectCategory ..................................................................................................... 582
ElementMorphing .................................................................................................................. 582
EvanescentWaveAttenuation .................................................................................................. 582
FluidBehavior ......................................................................................................................... 583
InternalObject ........................................................................................................................ 583
Location ................................................................................................................................. 583
PMLElementCoordinateSystem ............................................................................................... 583
PMLOptions ............................................................................................................................ 583
ReferencePressure .................................................................................................................. 583
ReferenceStaticPressure .......................................................................................................... 584
ReflectionCoefficient .............................................................................................................. 584
ReflectionCoefficientInNegativeXDirection .............................................................................. 584
ReflectionCoefficientInNegativeYDirection .............................................................................. 584
ReflectionCoefficientInNegativeZDirection .............................................................................. 584
ReflectionCoefficientInPositiveXDirection ............................................................................... 584
ReflectionCoefficientInPositiveYDirection ................................................................................ 585
ReflectionCoefficientInPositiveZDirection ................................................................................ 585
ReflectionCoefficientsType ...................................................................................................... 585
Structural ............................................................................................................................... 585
Suppressed ............................................................................................................................ 585
Thermal .................................................................................................................................. 585
ThermalStrain ......................................................................................................................... 586
ThermoelasticDamping .......................................................................................................... 586
Delete() .................................................................................................................................. 586
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 586
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 586
PipeIdealization ............................................................................................................................ 587

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

Children ................................................................................................................................. 587


DataModelObjectCategory ..................................................................................................... 588
Extend .................................................................................................................................... 588
Factor ..................................................................................................................................... 588
GeometrySelection ................................................................................................................. 588
InternalObject ........................................................................................................................ 588
Suppressed ............................................................................................................................ 588
Delete() .................................................................................................................................. 589
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 589
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 589
PointMass ..................................................................................................................................... 589
AppliedBy ............................................................................................................................... 591
BeamRadius ........................................................................................................................... 591
Behavior ................................................................................................................................. 591
CoordinateSystem .................................................................................................................. 591
DataModelObjectCategory ..................................................................................................... 591
InternalObject ........................................................................................................................ 591
Mass ....................................................................................................................................... 592
MassMomentOfInertiaX .......................................................................................................... 592
MassMomentOfInertiaY .......................................................................................................... 592
MassMomentOfInertiaZ .......................................................................................................... 592
Material .................................................................................................................................. 592
NodalCoordinateSystem ......................................................................................................... 592
PinballRegion ......................................................................................................................... 593
Suppressed ............................................................................................................................ 593
XCoordinate ........................................................................................................................... 593
YCoordinate ........................................................................................................................... 593
ZCoordinate ........................................................................................................................... 593
PromoteToRemotePoint() ........................................................................................................ 593
PostContactTool ........................................................................................................................... 594
DataModelObjectCategory ..................................................................................................... 594
InternalObject ........................................................................................................................ 595
AddFluidPressure() .................................................................................................................. 595
AddFrictionalStress() ............................................................................................................... 595
AddHeatFlux() ........................................................................................................................ 595
AddPressure() ......................................................................................................................... 595
AddSlidingDistance() .............................................................................................................. 595
PreContactTool ............................................................................................................................. 596
DataModelObjectCategory ..................................................................................................... 596
InternalObject ........................................................................................................................ 596
AddGap() ................................................................................................................................ 597
AddInitialInformation() ........................................................................................................... 597
AddPenetration() .................................................................................................................... 597
AddStatus() ............................................................................................................................ 597
PreMeshedCrack ........................................................................................................................... 597
BottomFaceNodes .................................................................................................................. 598
CoordinateSystem .................................................................................................................. 598
CrackFacesNodes .................................................................................................................... 598
CrackFront .............................................................................................................................. 599
CrackSourceType .................................................................................................................... 599
CrackSymmetry ...................................................................................................................... 599
DataModelObjectCategory ..................................................................................................... 599

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

InternalObject ........................................................................................................................ 599


ScopingMethod ...................................................................................................................... 599
SolutionContours ................................................................................................................... 600
Suppressed ............................................................................................................................ 600
TopFaceNodes ........................................................................................................................ 600
PreMeshedCyclicRegion ................................................................................................................ 600
BoundaryDOFOrientation ....................................................................................................... 601
DataModelObjectCategory ..................................................................................................... 601
InternalObject ........................................................................................................................ 601
NumberOfSectors ................................................................................................................... 602
RelativeDistanceTolerance ...................................................................................................... 602
PrimaryCriterion ........................................................................................................................... 602
BaseResult .............................................................................................................................. 603
DataModelObjectCategory ..................................................................................................... 603
InternalObject ........................................................................................................................ 603
Location ................................................................................................................................. 603
ReferenceType ........................................................................................................................ 604
SpatialReduction .................................................................................................................... 604
SpatialReductionMethod ........................................................................................................ 604
Step ....................................................................................................................................... 604
VectorReduction ..................................................................................................................... 604
ClearGeneratedData() ............................................................................................................. 604
EvaluateAllResults() ................................................................................................................. 605
Project .......................................................................................................................................... 605
Author .................................................................................................................................... 606
Children ................................................................................................................................. 606
Comments .............................................................................................................................. 606
CreationDate .......................................................................................................................... 606
CreationTime .......................................................................................................................... 606
DataModelObjectCategory ..................................................................................................... 607
FirstSaved ............................................................................................................................... 607
Images ................................................................................................................................... 607
ImportedSource ..................................................................................................................... 607
ImportedVersion ..................................................................................................................... 607
InternalObject ........................................................................................................................ 607
LastSaved ............................................................................................................................... 608
Model ..................................................................................................................................... 608
Models ***OBSOLETE*** Use 'Model' property instead. ............................................................ 608
PreparedFor ............................................................................................................................ 608
ProductVersion ....................................................................................................................... 608
SaveProjectAfterSolution ........................................................................................................ 608
SaveProjectBeforeSolution ...................................................................................................... 609
Subject ................................................................................................................................... 609
UnitSystem ............................................................................................................................. 609
AddComment() ....................................................................................................................... 609
AddImage(string) ................................................................................................................... 609
ClearGeneratedData() ............................................................................................................. 610
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 610
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 610
SpecifyMetricTemperatureInCelsius() ...................................................................................... 610
SpecifyMetricTemperatureInKelvin() ........................................................................................ 611
PullOutDirectionManufacturingConstraint .................................................................................... 611

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

Axis ........................................................................................................................................ 611


CoordinateSystem .................................................................................................................. 612
DataModelObjectCategory ..................................................................................................... 612
Direction ................................................................................................................................ 612
InternalObject ........................................................................................................................ 612
Location ................................................................................................................................. 612
ScopingMethod ...................................................................................................................... 612
ReactionForceConstraint ............................................................................................................... 613
AxisSelection .......................................................................................................................... 613
BoundType ............................................................................................................................. 613
DataModelObjectCategory ..................................................................................................... 614
InternalObject ........................................................................................................................ 614
Location ................................................................................................................................. 614
ReactionForceCriteria .............................................................................................................. 614
ScopingMethod ...................................................................................................................... 614
XComponentMax .................................................................................................................... 614
YComponentMax .................................................................................................................... 615
ZComponentMax .................................................................................................................... 615
RemotePoint ................................................................................................................................ 615
Behavior ................................................................................................................................. 616
Children ................................................................................................................................. 616
Comments .............................................................................................................................. 616
CoordinateSystem .................................................................................................................. 617
DataModelObjectCategory ..................................................................................................... 617
DOFSelection ......................................................................................................................... 617
GloballyAvailable .................................................................................................................... 617
InternalObject ........................................................................................................................ 617
Location ................................................................................................................................. 617
Material .................................................................................................................................. 618
OutlineSelection ..................................................................................................................... 618
PilotNodeAPDLName .............................................................................................................. 618
PinballRegion ......................................................................................................................... 618
Radius .................................................................................................................................... 618
RotationX ............................................................................................................................... 618
RotationY ............................................................................................................................... 619
RotationZ ............................................................................................................................... 619
ScopingMethod ...................................................................................................................... 619
Suppressed ............................................................................................................................ 619
XComponent .......................................................................................................................... 619
XCoordinate ........................................................................................................................... 619
YComponent .......................................................................................................................... 620
YCoordinate ........................................................................................................................... 620
ZComponent .......................................................................................................................... 620
ZCoordinate ........................................................................................................................... 620
AddCommandSnippet() .......................................................................................................... 620
AddComment() ....................................................................................................................... 620
Delete() .................................................................................................................................. 621
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 621
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 621
GetMeshRegion() .................................................................................................................... 621
PromoteToNamedSelection() .................................................................................................. 622
RemotePoints ............................................................................................................................... 622

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

Children ................................................................................................................................. 622


Comments .............................................................................................................................. 623
DataModelObjectCategory ..................................................................................................... 623
Figures ................................................................................................................................... 623
Images ................................................................................................................................... 623
InternalObject ........................................................................................................................ 623
ShowConnectionLines ............................................................................................................ 623
AddComment() ....................................................................................................................... 624
AddFigure() ............................................................................................................................ 624
AddImage(string) ................................................................................................................... 624
AddRemotePoint() .................................................................................................................. 624
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 624
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 625
ResponseConstraint ...................................................................................................................... 625
Children ................................................................................................................................. 626
DataModelObjectCategory ..................................................................................................... 626
EnvironmentSelection ............................................................................................................ 626
InternalObject ........................................................................................................................ 626
Suppressed ............................................................................................................................ 626
Delete() .................................................................................................................................. 627
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 627
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 627
ResponsePSDTool ......................................................................................................................... 627
Children ................................................................................................................................. 628
ClusteringFrequencyPoints ..................................................................................................... 628
Comments .............................................................................................................................. 629
DataModelObjectCategory ..................................................................................................... 629
Figures ................................................................................................................................... 629
Images ................................................................................................................................... 629
IncludeAllExcitationFrequencies .............................................................................................. 629
IncludeUserDefinedFrequencies .............................................................................................. 629
InternalObject ........................................................................................................................ 630
AddComment() ....................................................................................................................... 630
AddFigure() ............................................................................................................................ 630
AddImage(string) ................................................................................................................... 630
AddResponsePSD() ................................................................................................................. 630
Delete() .................................................................................................................................. 630
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 631
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 631
SelectionWorksheet ...................................................................................................................... 631
RowCount .............................................................................................................................. 633
AddRow() ............................................................................................................................... 633
DeleteRow(int) ....................................................................................................................... 634
Generate() .............................................................................................................................. 634
GetAction(int) ......................................................................................................................... 634
GetBodyTypeValue(int) ........................................................................................................... 634
GetCoordinateSystemSelection(int) ........................................................................................ 635
GetCriterion(int) ..................................................................................................................... 635
GetCriterionActive(int) ............................................................................................................ 635
GetEdgeTypeValue(int) ........................................................................................................... 635
GetFaceTypeValue(int) ............................................................................................................ 636
GetGeometryType(int) ............................................................................................................ 636

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

GetLowerBound(int) ............................................................................................................... 636


GetMeshElementTypeValue(int) .............................................................................................. 636
GetOperator(int) ..................................................................................................................... 637
GetStringValue(int) ................................................................................................................. 637
GetTag(uint) ........................................................................................................................... 637
GetUpperBound(int) ............................................................................................................... 638
GetValue(int) .......................................................................................................................... 638
SetAction(int, NamedSelectionWorksheetAction) .................................................................... 638
SetBodyTypeValue(int, NamedSelectionWorksheetBodyTypeValues) ........................................ 638
SetCoordinateSystemSelection(int, uint) .................................................................................. 639
SetCriterion(int, NamedSelectionWorksheetCriterion) .............................................................. 639
SetCriterionActive(int, bool) .................................................................................................... 639
SetEdgeTypeValue(int, NamedSelectionWorksheetEdgeTypeValues) ........................................ 640
SetEntityType(int, NamedSelectionWorksheetEntityType) ........................................................ 640
SetFaceTypeValue(int, NamedSelectionWorksheetFaceTypeValues) .......................................... 640
SetLowerBound(int, double) .................................................................................................... 641
SetMeshElementTypeValue(int, MeshElementShape) ............................................................... 641
SetOperator(int, NamedSelectionWorksheetOperator) ............................................................. 641
SetStringValue(int, string) ........................................................................................................ 642
SetTag(uint, string) .................................................................................................................. 642
SetUpperBound(int, double) ................................................................................................... 642
SetValue(int, double) ............................................................................................................... 643
SemiEllipticalCrack ....................................................................................................................... 643
AlignWithFaceNormal ............................................................................................................. 644
BottomFaceNodes .................................................................................................................. 644
CircumferentialDivisions ......................................................................................................... 645
Contact1Nodes ....................................................................................................................... 645
ContactPairsNodes ................................................................................................................. 645
CoordinateSystem .................................................................................................................. 645
CrackFacesNodes .................................................................................................................... 645
CrackFrontDivisions ................................................................................................................ 645
CrackFrontNodes .................................................................................................................... 646
CrackMeshMethod ................................................................................................................. 646
CrackShape ............................................................................................................................ 646
CrackSourceType .................................................................................................................... 646
DataModelObjectCategory ..................................................................................................... 646
FractureAffectedZone ............................................................................................................. 646
FractureAffectedZoneHeight ................................................................................................... 647
FrontElementSize .................................................................................................................... 647
GrowthRate ............................................................................................................................ 647
InternalObject ........................................................................................................................ 647
LargestContourRadius ............................................................................................................ 647
Location ................................................................................................................................. 647
MajorRadius ........................................................................................................................... 648
MeshContours ........................................................................................................................ 648
MinorRadius ........................................................................................................................... 648
ProjectToNearestSurface ......................................................................................................... 648
SolutionContours ................................................................................................................... 648
Suppressed ............................................................................................................................ 648
Target1Nodes ......................................................................................................................... 649
TopFaceNodes ........................................................................................................................ 649
XScaleFactor ........................................................................................................................... 649

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

YScaleFactor ........................................................................................................................... 649


ZScaleFactor ........................................................................................................................... 649
SMARTCrackGrowth ...................................................................................................................... 649
Analysis .................................................................................................................................. 651
AutomaticTimeStepping ......................................................................................................... 651
CrackGrowthLaw .................................................................................................................... 651
CrackGrowthMethodology ...................................................................................................... 651
CrackGrowthOption ................................................................................................................ 651
CriticalRate ............................................................................................................................. 651
DataModelObjectCategory ..................................................................................................... 652
FailureCriteriaOption .............................................................................................................. 652
InitialCrack ............................................................................................................................. 652
InitialTimeStep ....................................................................................................................... 652
InternalObject ........................................................................................................................ 652
Material .................................................................................................................................. 652
MaximumTimeStep ................................................................................................................ 653
MaxIncrementOfCrackExtension ............................................................................................. 653
MaxIncrementValue ................................................................................................................ 653
Method .................................................................................................................................. 653
MinimumTimeStep ................................................................................................................. 653
MinIncrementOfCrackExtension .............................................................................................. 653
MinIncrementValue ................................................................................................................ 654
NumberOfCycles ..................................................................................................................... 654
StopAtMaxCrackExtension ...................................................................................................... 654
StopAtMaxCrackExtensionValue .............................................................................................. 654
StressRatio .............................................................................................................................. 654
Suppressed ............................................................................................................................ 654
Solid ............................................................................................................................................. 655
Children ................................................................................................................................. 655
Comments .............................................................................................................................. 656
CoordinateSystem .................................................................................................................. 656
DataModelObjectCategory ..................................................................................................... 656
InternalObject ........................................................................................................................ 656
PartName ............................................................................................................................... 656
X1 .......................................................................................................................................... 656
X2 .......................................................................................................................................... 657
Y1 .......................................................................................................................................... 657
Y2 .......................................................................................................................................... 657
Z1 .......................................................................................................................................... 657
Z2 .......................................................................................................................................... 657
AddComment() ....................................................................................................................... 657
AddGeometry() ....................................................................................................................... 658
Delete() .................................................................................................................................. 658
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 658
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 658
RemoveGeometry() ................................................................................................................ 659
UpdateGeometry() .................................................................................................................. 659
Solution ....................................................................................................................................... 659
AllThreadsCPUTime ................................................................................................................ 668
CalculateBeamSectionResults ................................................................................................. 668
CellId ...................................................................................................................................... 668
Children ................................................................................................................................. 668

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

Comments .............................................................................................................................. 669


CyclicSectorDisplayRangeBegin .............................................................................................. 669
DataModelObjectCategory ..................................................................................................... 669
EigenSolverType ..................................................................................................................... 669
ElapsedRunTime ..................................................................................................................... 669
ElapsedTime ........................................................................................................................... 669
ElementLoadBalRatio .............................................................................................................. 670
Elements ................................................................................................................................ 670
ElementSelection ................................................................................................................... 670
EquationSolverType ................................................................................................................ 670
ExportTopologyFile ................................................................................................................. 670
Figures ................................................................................................................................... 670
GpuAcceleration ..................................................................................................................... 671
GPUType ................................................................................................................................ 671
Images ................................................................................................................................... 671
InternalObject ........................................................................................................................ 671
IOBound ................................................................................................................................. 671
IORead ................................................................................................................................... 671
IOWrite ................................................................................................................................... 672
IsDataExtractionComplete ...................................................................................................... 672
IsDistributedSolution .............................................................................................................. 672
IsEigenSolver .......................................................................................................................... 672
IsGPUAccelerationRequested .................................................................................................. 672
IsUnsymmetricMatrixSolve ...................................................................................................... 672
License ................................................................................................................................... 673
LicenseCoresAvailable ............................................................................................................. 673
MainThreadCPUTime .............................................................................................................. 673
MaximumRefinementLoops .................................................................................................... 673
MemoryAvailable .................................................................................................................... 673
MemoryUsed .......................................................................................................................... 673
MPIType ................................................................................................................................. 674
MSUPHarmonicAnalysis .......................................................................................................... 674
Nodes ..................................................................................................................................... 674
NumberofSectors ................................................................................................................... 674
NumCoresAvailable ................................................................................................................ 674
NumGPURequested ................................................................................................................ 674
NumMachinesRequested ........................................................................................................ 675
NumProcRequested ................................................................................................................ 675
NumVirtualCoresAvailable ...................................................................................................... 675
OperatingSystem .................................................................................................................... 675
ProcessorModel ...................................................................................................................... 675
RefinementDepth ................................................................................................................... 675
ResultFileSize .......................................................................................................................... 676
SolutionInformation ............................................................................................................... 676
SolutionUnitSystem ................................................................................................................ 676
SolverData .............................................................................................................................. 676
SolverType .............................................................................................................................. 676
Status ..................................................................................................................................... 676
TabularData ............................................................................................................................ 677
TimeToCombineDistributedFiles ............................................................................................. 677
TopologyResult ....................................................................................................................... 677
TotalMemoryUsed .................................................................................................................. 677

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

WorkingDir ............................................................................................................................. 677


AddAccelerationFrequencyResponse() .................................................................................... 677
AddAccelerationPhaseResponse() ........................................................................................... 678
AddAccelerationProbe() .......................................................................................................... 678
AddAccumulatedEquivalentPlasticStrain() ............................................................................... 678
AddAcousticAbsorptionCoefficient() ....................................................................................... 678
AddAcousticAWeightedSoundPressureLevel() ......................................................................... 678
AddAcousticAWeightedSPLFrequencyResponse() .................................................................... 678
AddAcousticDiffuseSoundTransmissionLoss() .......................................................................... 679
AddAcousticDirectionalVelocityResult() ................................................................................... 679
AddAcousticFarFieldAWeightedSPL() ....................................................................................... 679
AddAcousticFarFieldAWeightedSPLMic() ................................................................................. 679
AddAcousticFarFieldDirectivity() ............................................................................................. 679
AddAcousticFarFieldMaximumPressure() ................................................................................. 679
AddAcousticFarFieldMaximumPressureMic() ........................................................................... 680
AddAcousticFarFieldMaximumScatteredPressure() .................................................................. 680
AddAcousticFarFieldPhase() .................................................................................................... 680
AddAcousticFarFieldPhaseMic() .............................................................................................. 680
AddAcousticFarFieldSoundPowerLevel() .................................................................................. 680
AddAcousticFarFieldSoundPowerLevelWaterfallDiagram() ....................................................... 680
AddAcousticFarFieldSPL() ....................................................................................................... 681
AddAcousticFarFieldSPLMic() .................................................................................................. 681
AddAcousticFarFieldSPLMicWaterfallDiagram() ....................................................................... 681
AddAcousticFarFieldTargetStrength() ...................................................................................... 681
AddAcousticFrequencyBandAWeightedSPL() ........................................................................... 681
AddAcousticFrequencyBandSPL() ........................................................................................... 681
AddAcousticKineticEnergy() .................................................................................................... 682
AddAcousticKineticEnergyFrequencyResponse() ..................................................................... 682
AddAcousticPotentialEnergy() ................................................................................................. 682
AddAcousticPotentialEnergyFrequencyResponse() .................................................................. 682
AddAcousticPressureFrequencyResponse() ............................................................................. 682
AddAcousticPressureResult() ................................................................................................... 682
AddAcousticReturnLoss() ........................................................................................................ 683
AddAcousticSoundPressureLevel() .......................................................................................... 683
AddAcousticSPLFrequencyResponse() ..................................................................................... 683
AddAcousticTotalVelocityResult() ............................................................................................ 683
AddAcousticTransmissionLoss() .............................................................................................. 683
AddAcousticVelocityFrequencyResponse() .............................................................................. 683
AddAngularAccelerationProbe() .............................................................................................. 684
AddAngularVelocityProbe() ..................................................................................................... 684
AddBeamProbe() .................................................................................................................... 684
AddBeamTool() ....................................................................................................................... 684
AddBearingProbe() ................................................................................................................. 684
AddBendingStressEquivalent() ................................................................................................ 684
AddBendingStressIntensity() ................................................................................................... 685
AddBoltPretensionProbe() ...................................................................................................... 685
AddBoltTool() ......................................................................................................................... 685
AddCampbellDiagram() .......................................................................................................... 685
AddCommandSnippet() .......................................................................................................... 685
AddComment() ....................................................................................................................... 685
AddCompositeCriterion() ........................................................................................................ 686
AddContactTool() ................................................................................................................... 686

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

AddCurrentDensity() ............................................................................................................... 686


AddCurrentDensityProbe() ...................................................................................................... 686
AddDamageStatus() ................................................................................................................ 686
AddDeformationFrequencyResponse() .................................................................................... 686
AddDeformationPhaseResponse() ........................................................................................... 687
AddDeformationProbe() ......................................................................................................... 687
AddDirectionalAcceleration() .................................................................................................. 687
AddDirectionalAccelerationPSD() ............................................................................................ 687
AddDirectionalAccelerationRS() .............................................................................................. 687
AddDirectionalAxialForce() ..................................................................................................... 687
AddDirectionalBendingMoment() ........................................................................................... 688
AddDirectionalCurrentDensity() .............................................................................................. 688
AddDirectionalDeformation() .................................................................................................. 688
AddDirectionalElectricFieldIntensity() ..................................................................................... 688
AddDirectionalHeatFlux() ........................................................................................................ 688
AddDirectionalMagneticFieldIntensity() .................................................................................. 688
AddDirectionalMagneticFluxDensity() ..................................................................................... 689
AddDirectionalShearForce() .................................................................................................... 689
AddDirectionalTorsionalMoment() .......................................................................................... 689
AddDirectionalVelocity() ......................................................................................................... 689
AddDirectionalVelocityPSD() ................................................................................................... 689
AddDirectionalVelocityRS() ..................................................................................................... 689
AddElasticStrainFrequencyResponse() ..................................................................................... 690
AddElasticStrainIntensity() ...................................................................................................... 690
AddElasticStrainPhaseResponse() ............................................................................................ 690
AddElectricFieldProbe() .......................................................................................................... 690
AddElectricPotential() ............................................................................................................. 690
AddElectricVoltage() ............................................................................................................... 690
AddElementalEulerXYAngle() .................................................................................................. 691
AddElementalEulerXZAngle() .................................................................................................. 691
AddElementalEulerYZAngle() .................................................................................................. 691
AddElementalStrainEnergy() ................................................................................................... 691
AddElementalTriads() .............................................................................................................. 691
AddEmagReactionProbe() ....................................................................................................... 691
AddEnergyDissipatedPerUnitVolume() .................................................................................... 692
AddEnergyProbe() .................................................................................................................. 692
AddEquivalentCreepStrain() .................................................................................................... 692
AddEquivalentCreepStrainRST() .............................................................................................. 692
AddEquivalentElasticStrain() ................................................................................................... 692
AddEquivalentElasticStrainRST() .............................................................................................. 692
AddEquivalentPlasticStrain() ................................................................................................... 693
AddEquivalentPlasticStrainRST() .............................................................................................. 693
AddEquivalentRadiatedPower() ............................................................................................... 693
AddEquivalentRadiatedPowerLevel() ....................................................................................... 693
AddEquivalentRadiatedPowerLevelWaterfallDiagram() ............................................................ 693
AddEquivalentRadiatedPowerWaterfallDiagram() .................................................................... 693
AddEquivalentStress() ............................................................................................................. 694
AddEquivalentStressPSD() ....................................................................................................... 694
AddEquivalentStressRS() ......................................................................................................... 694
AddEquivalentTotalStrain() ..................................................................................................... 694
AddExpansionSettings() .......................................................................................................... 694
AddFatigueTool() .................................................................................................................... 694

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

AddFiberCompressiveDamageVariable() ................................................................................. 695


AddFiberCompressiveFailureCriterion() ................................................................................... 695
AddFiberTensileDamageVariable() ........................................................................................... 695
AddFiberTensileFailureCriterion() ............................................................................................ 695
AddFieldIntensityProbe() ........................................................................................................ 695
AddFigure() ............................................................................................................................ 695
AddFluidFlowRate() ................................................................................................................ 696
AddFluidHeatConductionRate() .............................................................................................. 696
AddFluidHeatTransportRate() .................................................................................................. 696
AddFluxDensityProbe() ........................................................................................................... 696
AddFluxLinkage() .................................................................................................................... 696
AddForceReaction() ................................................................................................................ 696
AddForceSummationProbe() ................................................................................................... 697
AddFractureTool() ................................................................................................................... 697
AddGeneralizedPlaneStrainProbe() ......................................................................................... 697
AddHeatFluxProbe() ............................................................................................................... 697
AddImage(string) ................................................................................................................... 697
AddInductance() ..................................................................................................................... 697
AddJointProbe() ..................................................................................................................... 698
AddJouleHeat() ....................................................................................................................... 698
AddJouleHeatProbe() .............................................................................................................. 698
AddLatticeDensity() ................................................................................................................ 698
AddLatticeElementalDensity() ................................................................................................. 698
AddLinearizedEquivalentStress() ............................................................................................. 698
AddLinearizedMaximumPrincipalStress() ................................................................................. 699
AddLinearizedMaximumShearStress() ..................................................................................... 699
AddLinearizedMiddlePrincipalStress() ..................................................................................... 699
AddLinearizedMinimumPrincipalStress() ................................................................................. 699
AddLinearizedNormalStress() .................................................................................................. 699
AddLinearizedShearStress() ..................................................................................................... 699
AddLinearizedStressIntensity() ................................................................................................ 700
AddMagneticCoenergy() ......................................................................................................... 700
AddMagneticDirectionalForces() ............................................................................................. 700
AddMagneticError() ................................................................................................................ 700
AddMagneticFluxProbe() ........................................................................................................ 700
AddMagneticPotential() .......................................................................................................... 700
AddMagneticTotalForces() ...................................................................................................... 701
AddMatrixCompressiveDamageVariable() ............................................................................... 701
AddMatrixCompressiveFailureCriterion() ................................................................................. 701
AddMatrixTensileDamageVariable() ........................................................................................ 701
AddMatrixTensileFailureCriterion() .......................................................................................... 701
AddMaximumFailureCriteria() ................................................................................................. 701
AddMaximumPrincipalElasticStrain() ....................................................................................... 702
AddMaximumPrincipalStress() ................................................................................................ 702
AddMaximumPrincipalThermalStrain() .................................................................................... 702
AddMaximumShearElasticStrain() ........................................................................................... 702
AddMaximumShearStress() ..................................................................................................... 702
AddMembraneStressEquivalent() ............................................................................................ 702
AddMembraneStressIntensity() ............................................................................................... 703
AddMiddlePrincipalElasticStrain() ............................................................................................ 703
AddMiddlePrincipalStress() ..................................................................................................... 703
AddMiddlePrincipalThermalStrain() ......................................................................................... 703

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

AddMinimumPrincipalElasticStrain() ....................................................................................... 703


AddMinimumPrincipalStress() ................................................................................................. 703
AddMomentReaction() ........................................................................................................... 704
AddMullinsDamageVariable() .................................................................................................. 704
AddMullinsMaximumPreviousStrainEnergy() ........................................................................... 704
AddNewtonRaphsonResidualForce() ....................................................................................... 704
AddNewtonRaphsonResidualHeat() ........................................................................................ 704
AddNewtonRaphsonResidualMoment() .................................................................................. 704
AddNodalEulerXYAngle() ........................................................................................................ 705
AddNodalEulerXZAngle() ........................................................................................................ 705
AddNodalEulerYZAngle() ........................................................................................................ 705
AddNodalTriads() .................................................................................................................... 705
AddNormalElasticStrain() ........................................................................................................ 705
AddNormalGasketPressure() ................................................................................................... 705
AddNormalGasketTotalClosure() ............................................................................................. 706
AddNormalStress() .................................................................................................................. 706
AddPosition() .......................................................................................................................... 706
AddPrimaryCriterion() ............................................................................................................. 706
AddRadiationProbe() .............................................................................................................. 706
AddReactionProbe() ............................................................................................................... 706
AddResponsePSD() ................................................................................................................. 707
AddResponsePSDTool() ........................................................................................................... 707
AddRotationProbe() ................................................................................................................ 707
AddShapeFinder() ................................................................................................................... 707
AddShapeFinderElemental() ................................................................................................... 707
AddShearDamageVariable() .................................................................................................... 707
AddShearElasticStrain() ........................................................................................................... 708
AddShearGasketPressure() ...................................................................................................... 708
AddShearGasketTotalClosure() ................................................................................................ 708
AddShearMomentDiagramMSUM() ......................................................................................... 708
AddShearMomentDiagramMY() .............................................................................................. 708
AddShearMomentDiagramMZ() .............................................................................................. 708
AddShearMomentDiagramUSUM() .......................................................................................... 709
AddShearMomentDiagramUY() ............................................................................................... 709
AddShearMomentDiagramUZ() ............................................................................................... 709
AddShearMomentDiagramVSUM() .......................................................................................... 709
AddShearMomentDiagramVY() ............................................................................................... 709
AddShearMomentDiagramVZ() ............................................................................................... 709
AddShearStress() .................................................................................................................... 710
AddShellBendingStress() ......................................................................................................... 710
AddShellBottomPeakStress() ................................................................................................... 710
AddShellMembraneStress() ..................................................................................................... 710
AddShellTopPeakStress() ......................................................................................................... 710
AddSpringProbe() ................................................................................................................... 710
AddStabilizationEnergy() ........................................................................................................ 711
AddStrainProbe() .................................................................................................................... 711
AddStressFrequencyResponse() .............................................................................................. 711
AddStressIntensity() ................................................................................................................ 711
AddStressPhaseResponse() ..................................................................................................... 711
AddStressProbe() .................................................................................................................... 711
AddStressTool() ...................................................................................................................... 712
AddStructuralError() ................................................................................................................ 712

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

AddStructuralStrainEnergy() ................................................................................................... 712


AddTemperature() .................................................................................................................. 712
AddTemperatureProbe() ......................................................................................................... 712
AddThermalError() .................................................................................................................. 712
AddThermalStrain() ................................................................................................................ 713
AddThermalStrainEnergy() ...................................................................................................... 713
AddTopologyDensity() ............................................................................................................ 713
AddTopologyElementalDensity() ............................................................................................. 713
AddTorqueProbe() .................................................................................................................. 713
AddTotalAcceleration() ........................................................................................................... 713
AddTotalAxialForce() ............................................................................................................... 714
AddTotalBendingMoment() .................................................................................................... 714
AddTotalCurrentDensity() ....................................................................................................... 714
AddTotalDeformation() ........................................................................................................... 714
AddTotalElectricFieldIntensity() ............................................................................................... 714
AddTotalHeatFlux() ................................................................................................................. 714
AddTotalMagneticFieldIntensity() ............................................................................................ 715
AddTotalMagneticFluxDensity() .............................................................................................. 715
AddTotalShearForce() ............................................................................................................. 715
AddTotalTorsionalMoment() .................................................................................................... 715
AddTotalVelocity() .................................................................................................................. 715
AddUserDefinedResult() .......................................................................................................... 715
AddVariableGraph() ................................................................................................................ 716
AddVectorAxialForce() ............................................................................................................ 716
AddVectorBendingMoment() .................................................................................................. 716
AddVectorDeformation() ......................................................................................................... 716
AddVectorHeatFlux() ............................................................................................................... 716
AddVectorPrincipalElasticStrain() ............................................................................................ 716
AddVectorPrincipalStress() ...................................................................................................... 717
AddVectorShearForce() ........................................................................................................... 717
AddVectorTorsionalMoment() ................................................................................................. 717
AddVelocityFrequencyResponse() ........................................................................................... 717
AddVelocityPhaseResponse() .................................................................................................. 717
AddVelocityProbe() ................................................................................................................. 717
AddVoltageProbe() ................................................................................................................. 718
AddVolume() .......................................................................................................................... 718
AddVolumeProbe() ................................................................................................................. 718
ClearGeneratedData() ............................................................................................................. 718
EvaluateAllResults() ................................................................................................................. 718
ExtractSolutionStatistics() ....................................................................................................... 718
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 719
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 719
GetResults() ............................................................................................................................ 719
OpenSolverFilesDirectory() ..................................................................................................... 720
ReadAnsysResultFile() ............................................................................................................. 720
ReadGivenAnsysResultFile(string, UnitSystemIDType) .............................................................. 720
Solve(bool, SolveConfiguration) .............................................................................................. 720
Solve(bool, string) ................................................................................................................... 721
SolutionCombination ................................................................................................................... 721
Children ................................................................................................................................. 723
Comments .............................................................................................................................. 724
DataModelObjectCategory ..................................................................................................... 724

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

Definition ............................................................................................................................... 724


Images ................................................................................................................................... 724
InternalObject ........................................................................................................................ 724
WorksheetType ....................................................................................................................... 724
AddBeamTool() ....................................................................................................................... 725
AddComment() ....................................................................................................................... 725
AddContactTool() ................................................................................................................... 725
AddDirectionalAcceleration() .................................................................................................. 725
AddDirectionalAxialForce() ..................................................................................................... 725
AddDirectionalBendingMoment() ........................................................................................... 725
AddDirectionalDeformation() .................................................................................................. 726
AddDirectionalShearForce() .................................................................................................... 726
AddDirectionalTorsionalMoment() .......................................................................................... 726
AddDirectionalVelocity() ......................................................................................................... 726
AddElasticStrainIntensity() ...................................................................................................... 726
AddEquivalentElasticStrain() ................................................................................................... 726
AddEquivalentStress() ............................................................................................................. 727
AddEquivalentTotalStrain() ..................................................................................................... 727
AddFatigueTool() .................................................................................................................... 727
AddImage(string) ................................................................................................................... 727
AddLinearizedEquivalentStress() ............................................................................................. 727
AddLinearizedMaximumPrincipalStress() ................................................................................. 727
AddLinearizedMaximumShearStress() ..................................................................................... 728
AddLinearizedMiddlePrincipalStress() ..................................................................................... 728
AddLinearizedMinimumPrincipalStress() ................................................................................. 728
AddLinearizedNormalStress() .................................................................................................. 728
AddLinearizedShearStress() ..................................................................................................... 728
AddLinearizedStressIntensity() ................................................................................................ 728
AddMaximumPrincipalElasticStrain() ....................................................................................... 729
AddMaximumPrincipalStress() ................................................................................................ 729
AddMaximumShearElasticStrain() ........................................................................................... 729
AddMaximumShearStress() ..................................................................................................... 729
AddMiddlePrincipalElasticStrain() ............................................................................................ 729
AddMiddlePrincipalStress() ..................................................................................................... 729
AddMinimumPrincipalElasticStrain() ....................................................................................... 730
AddMinimumPrincipalStress() ................................................................................................. 730
AddNormalElasticStrain() ........................................................................................................ 730
AddNormalStress() .................................................................................................................. 730
AddShearElasticStrain() ........................................................................................................... 730
AddShearMomentDiagramMSUM() ......................................................................................... 730
AddShearMomentDiagramMY() .............................................................................................. 731
AddShearMomentDiagramMZ() .............................................................................................. 731
AddShearMomentDiagramUSUM() .......................................................................................... 731
AddShearMomentDiagramUY() ............................................................................................... 731
AddShearMomentDiagramUZ() ............................................................................................... 731
AddShearMomentDiagramVSUM() .......................................................................................... 731
AddShearMomentDiagramVY() ............................................................................................... 732
AddShearMomentDiagramVZ() ............................................................................................... 732
AddShearStress() .................................................................................................................... 732
AddStressIntensity() ................................................................................................................ 732
AddStressTool() ...................................................................................................................... 732
AddTotalAcceleration() ........................................................................................................... 732

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

AddTotalAxialForce() ............................................................................................................... 733


AddTotalBendingMoment() .................................................................................................... 733
AddTotalDeformation() ........................................................................................................... 733
AddTotalShearForce() ............................................................................................................. 733
AddTotalTorsionalMoment() .................................................................................................... 733
AddTotalVelocity() .................................................................................................................. 733
AddUserDefinedResult() .......................................................................................................... 734
AddVectorAxialForce() ............................................................................................................ 734
AddVectorBendingMoment() .................................................................................................. 734
AddVectorPrincipalElasticStrain() ............................................................................................ 734
AddVectorPrincipalStress() ...................................................................................................... 734
AddVectorShearForce() ........................................................................................................... 734
AddVectorTorsionalMoment() ................................................................................................. 735
ClearGeneratedData() ............................................................................................................. 735
Delete() .................................................................................................................................. 735
EvaluateAllResults() ................................................................................................................. 735
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 735
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 736
SolutionCombinationDefinition .................................................................................................... 736
BaseCaseCount ....................................................................................................................... 737
LoadCombinationCount ......................................................................................................... 737
AddBaseCase(string, Analysis, double) ..................................................................................... 738
AddLoadCombination(string, int) ............................................................................................ 738
DeleteBaseCase(int) ................................................................................................................ 738
DeleteLoadCombination(int) ................................................................................................... 739
Export(string) ......................................................................................................................... 739
GetBaseCaseAnalysis(int) ........................................................................................................ 739
GetBaseCaseFrequency(int) .................................................................................................... 739
GetBaseCaseName(int) ........................................................................................................... 740
GetBaseCasePhaseAngle(int) .................................................................................................. 740
GetBaseCaseTime(int) ............................................................................................................. 740
GetCoefficient(int, int) ............................................................................................................. 740
GetLoadCombinationName(int) .............................................................................................. 741
GetLoadCombinationType(int) ................................................................................................ 741
Import(string) ......................................................................................................................... 741
SetBaseCaseAnalysis(int, Analysis) ........................................................................................... 742
SetBaseCaseFrequency(int, double) ......................................................................................... 742
SetBaseCaseName(int, string) .................................................................................................. 742
SetBaseCasePhaseAngle(int, double) ....................................................................................... 743
SetBaseCaseTime(int, double) ................................................................................................. 743
SetCoefficient(int, int, double) ................................................................................................. 743
SetLoadCombinationName(int, string) ..................................................................................... 744
SetLoadCombinationType(int, int) ........................................................................................... 744
SolutionInformation ..................................................................................................................... 744
ActivateVisibility ..................................................................................................................... 748
Children ................................................................................................................................. 748
Comments .............................................................................................................................. 748
Component ............................................................................................................................ 748
DataModelObjectCategory ..................................................................................................... 748
Display ................................................................................................................................... 748
DisplayFilterDuringSolve ......................................................................................................... 749
DisplayPoints .......................................................................................................................... 749

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

DisplayType ............................................................................................................................ 749


DrawConnectionsAttachedTo ................................................................................................. 749
EnvironmentSelection ............................................................................................................ 749
Figures ................................................................................................................................... 749
IdentifyElementViolations ....................................................................................................... 750
Images ................................................................................................................................... 750
InternalObject ........................................................................................................................ 750
LineColor ................................................................................................................................ 750
LineThickness ......................................................................................................................... 750
ModeNumber ......................................................................................................................... 750
NewtonRaphsonResiduals ...................................................................................................... 751
ResponseConstraint ................................................................................................................ 751
ShowHeatResiduals ................................................................................................................ 751
ShowMomentResiduals .......................................................................................................... 751
SolutionOutput ...................................................................................................................... 751
StepNumber ........................................................................................................................... 751
StepSelectionMode ................................................................................................................ 752
SummaryType ........................................................................................................................ 752
UpdateInterval ....................................................................................................................... 752
VisibleOnResults ..................................................................................................................... 752
AddChattering() ...................................................................................................................... 752
AddClosedPenetration() .......................................................................................................... 752
AddComment() ....................................................................................................................... 753
AddContactDepth() ................................................................................................................ 753
AddContactEnergy() ............................................................................................................... 753
AddContactForce() .................................................................................................................. 753
AddContactHeatFlux() ............................................................................................................ 753
AddContactingArea() .............................................................................................................. 753
AddContactMaximumNormalStiffness() .................................................................................. 754
AddContactMinimumNormalStiffness() ................................................................................... 754
AddContactPressure() ............................................................................................................. 754
AddDensity() .......................................................................................................................... 754
AddDirectionalAcceleration() .................................................................................................. 754
AddDirectionalDeformation() .................................................................................................. 754
AddDirectionalVelocity() ......................................................................................................... 755
AddEffectiveStrain() ................................................................................................................ 755
AddEffectiveStress() ................................................................................................................ 755
AddElasticSlip() ....................................................................................................................... 755
AddExternalForce() ................................................................................................................. 755
AddFigure() ............................................................................................................................ 755
AddFluidPressure() .................................................................................................................. 756
AddForceReaction() ................................................................................................................ 756
AddFrictionalDissipationEnergy() ............................................................................................ 756
AddFrictionalStress() ............................................................................................................... 756
AddGap() ................................................................................................................................ 756
AddHourglassEnergy() ............................................................................................................ 756
AddImage(string) ................................................................................................................... 757
AddInternalEnergy() ............................................................................................................... 757
AddKineticEnergy() ................................................................................................................. 757
AddLatticeDensity() ................................................................................................................ 757
AddLatticeElementalDensity() ................................................................................................. 757
AddMaximumDampingPressure() ........................................................................................... 757

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

AddMaximumGeometricSlidingDistance() ............................................................................... 758


AddMaximumTangentialStiffness() .......................................................................................... 758
AddMinimumGeometricSlidingDistance() ............................................................................... 758
AddMinimumTangentialStiffness() .......................................................................................... 758
AddMomentReaction() ........................................................................................................... 758
AddMomentum() .................................................................................................................... 758
AddNumberContacting() ........................................................................................................ 759
AddNumberSticking() ............................................................................................................. 759
AddNumberWithLargePenetration() ........................................................................................ 759
AddNumberWithTooMuchSliding() ......................................................................................... 759
AddPenetration() .................................................................................................................... 759
AddPlasticWork() .................................................................................................................... 759
AddPosition() .......................................................................................................................... 760
AddPressure() ......................................................................................................................... 760
AddResultingPinball() ............................................................................................................. 760
AddSlidingDistance() .............................................................................................................. 760
AddSlidingIndication() ............................................................................................................ 760
AddSpringTrackerDampingForce() .......................................................................................... 760
AddSpringTrackerElasticForce() ............................................................................................... 761
AddSpringTrackerElongation() ................................................................................................ 761
AddSpringTrackerVelocity() ..................................................................................................... 761
AddStabilizationEnergy() ........................................................................................................ 761
AddStiffnessEnergy() .............................................................................................................. 761
AddStrainEnergy() .................................................................................................................. 761
AddTangentialDampingStress() ............................................................................................... 762
AddTemperature() .................................................................................................................. 762
AddTopologyDensity() ............................................................................................................ 762
AddTopologyElementalDensity() ............................................................................................. 762
AddTotalEnergy() .................................................................................................................... 762
AddTotalForceFromContactPressureX() ................................................................................... 762
AddTotalForceFromContactPressureY() ................................................................................... 763
AddTotalForceFromContactPressureZ() ................................................................................... 763
AddTotalForceFromTangentialStressX() ................................................................................... 763
AddTotalForceFromTangentialStressY() ................................................................................... 763
AddTotalForceFromTangentialStressZ() ................................................................................... 763
AddTotalMassAverageVelocity() .............................................................................................. 763
AddVolumeLossDueToWear() .................................................................................................. 764
EvaluateAllContactTrackers() ................................................................................................... 764
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 764
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 764
ImportResultTrackersFromFile(string) ...................................................................................... 765
STL ............................................................................................................................................... 765
Children ................................................................................................................................. 766
Color ...................................................................................................................................... 766
Comments .............................................................................................................................. 766
DataModelObjectCategory ..................................................................................................... 766
Figures ................................................................................................................................... 766
FileName ................................................................................................................................ 767
Images ................................................................................................................................... 767
InternalObject ........................................................................................................................ 767
LengthUnits ............................................................................................................................ 767
ShowAlways ........................................................................................................................... 767

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

Statistics ................................................................................................................................. 767


Suppressed ............................................................................................................................ 768
TranslateX .............................................................................................................................. 768
TranslateY ............................................................................................................................... 768
TranslateZ ............................................................................................................................... 768
AddComment() ....................................................................................................................... 768
AddFigure() ............................................................................................................................ 768
AddImage(string) ................................................................................................................... 769
Delete() .................................................................................................................................. 769
ExportStl(string, Progress) ....................................................................................................... 769
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 769
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 770
ImportSTL() ............................................................................................................................ 770
Surface ......................................................................................................................................... 770
Children ................................................................................................................................. 771
Comments .............................................................................................................................. 771
CoordinateSystem .................................................................................................................. 771
DataModelObjectCategory ..................................................................................................... 771
Figures ................................................................................................................................... 772
Images ................................................................................................................................... 772
InternalObject ........................................................................................................................ 772
Suppressed ............................................................................................................................ 772
AddComment() ....................................................................................................................... 772
AddFigure() ............................................................................................................................ 772
AddImage(string) ................................................................................................................... 773
Delete() .................................................................................................................................. 773
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 773
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 773
SurfaceCoating ............................................................................................................................. 774
Children ................................................................................................................................. 775
Comments .............................................................................................................................. 775
CoordinateSystem .................................................................................................................. 775
DataModelObjectCategory ..................................................................................................... 775
Figures ................................................................................................................................... 775
Images ................................................................................................................................... 775
InternalObject ........................................................................................................................ 776
Location ................................................................................................................................. 776
Material .................................................................................................................................. 776
Suppressed ............................................................................................................................ 776
SurfaceCoatingStiffnessBehavior ............................................................................................. 776
Thickness ............................................................................................................................... 776
AddComment() ....................................................................................................................... 777
AddFigure() ............................................................................................................................ 777
AddImage(string) ................................................................................................................... 777
Delete() .................................................................................................................................. 777
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 777
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 778
Symmetry ..................................................................................................................................... 778
Children ................................................................................................................................. 779
Comments .............................................................................................................................. 779
DataModelObjectCategory ..................................................................................................... 779
Figures ................................................................................................................................... 779

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

Images ................................................................................................................................... 780


InternalObject ........................................................................................................................ 780
AddComment() ....................................................................................................................... 780
AddCyclicRegion() .................................................................................................................. 780
AddFigure() ............................................................................................................................ 780
AddGeneralAxisymmetric() ..................................................................................................... 780
AddImage(string) ................................................................................................................... 781
AddLinearPeriodicRegion() ..................................................................................................... 781
AddPeriodicRegion() ............................................................................................................... 781
AddPreMeshedCyclicRegion() ................................................................................................. 781
AddSymmetryRegion() ........................................................................................................... 781
Delete() .................................................................................................................................. 781
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 782
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 782
SymmetryGeneral ......................................................................................................................... 782
Children ................................................................................................................................. 783
Comments .............................................................................................................................. 783
CoordinateSystem .................................................................................................................. 784
DataModelObjectCategory ..................................................................................................... 784
Figures ................................................................................................................................... 784
HighBoundaryLocation ........................................................................................................... 784
Images ................................................................................................................................... 784
InternalObject ........................................................................................................................ 784
Location ................................................................................................................................. 785
LowBoundaryLocation ............................................................................................................ 785
ScopeMode ............................................................................................................................ 785
Suppressed ............................................................................................................................ 785
AddComment() ....................................................................................................................... 785
AddFigure() ............................................................................................................................ 785
AddImage(string) ................................................................................................................... 786
Delete() .................................................................................................................................. 786
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 786
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 786
SymmetryManufacturingConstraint .............................................................................................. 787
Axis ........................................................................................................................................ 787
CoordinateSystem .................................................................................................................. 788
DataModelObjectCategory ..................................................................................................... 788
InternalObject ........................................................................................................................ 788
Location ................................................................................................................................. 788
ScopingMethod ...................................................................................................................... 788
SymmetryRegion .......................................................................................................................... 788
Behavior ................................................................................................................................. 789
DataModelObjectCategory ..................................................................................................... 790
InternalObject ........................................................................................................................ 790
LinearShift .............................................................................................................................. 790
Location ................................................................................................................................. 790
PeriodicityDirection ................................................................................................................ 790
SymmetryNormal ................................................................................................................... 790
Type ....................................................................................................................................... 791
FlipHighLow() ......................................................................................................................... 791
TemperatureConstraint ................................................................................................................. 791
DataModelObjectCategory ..................................................................................................... 792

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

InternalObject ........................................................................................................................ 792


Location ................................................................................................................................. 792
ScopingMethod ...................................................................................................................... 792
TemperatureAbsMax ............................................................................................................... 792
ThermalPointMass ........................................................................................................................ 792
AppliedBy ............................................................................................................................... 793
Behavior ................................................................................................................................. 794
CoordinateSystem .................................................................................................................. 794
DataModelObjectCategory ..................................................................................................... 794
InternalObject ........................................................................................................................ 794
PinballRegion ......................................................................................................................... 794
Suppressed ............................................................................................................................ 794
ThermalCapacitance ............................................................................................................... 795
PromoteToRemotePoint() ........................................................................................................ 795
Thickness ..................................................................................................................................... 795
Children ................................................................................................................................. 796
Comments .............................................................................................................................. 796
DataModelObjectCategory ..................................................................................................... 796
Figures ................................................................................................................................... 796
Images ................................................................................................................................... 796
IndependentVariable .............................................................................................................. 797
InternalObject ........................................................................................................................ 797
Location ................................................................................................................................. 797
NumberOfSegments ............................................................................................................... 797
OffsetType .............................................................................................................................. 797
RangeMaximum ..................................................................................................................... 797
RangeMinimum ...................................................................................................................... 798
ScopeMode ............................................................................................................................ 798
Suppressed ............................................................................................................................ 798
ThicknessField ........................................................................................................................ 798
XYZFunctionCoordinateSystem ............................................................................................... 798
AddComment() ....................................................................................................................... 798
AddFigure() ............................................................................................................................ 799
AddImage(string) ................................................................................................................... 799
Delete() .................................................................................................................................. 799
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 799
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 800
Tree .............................................................................................................................................. 800
ActiveObjects ......................................................................................................................... 801
AllObjects ............................................................................................................................... 801
CurrentFilter ........................................................................................................................... 801
CurrentSearchGraphics ........................................................................................................... 801
CurrentSearchState ................................................................................................................. 802
CurrentSearchString ............................................................................................................... 802
FirstActiveObject .................................................................................................................... 802
GroupingFoldersVisible ........................................................................................................... 802
Activate(IEnumerable<DataModelObject>) ............................................................................. 802
ClearFilter() ............................................................................................................................. 803
ClearSort() .............................................................................................................................. 803
Filter(string, string, ObjectState, VisibilityType, TreeFilterObjectClass, CoordinateSystem, string,
Analysis, TreeFilterScopingType, TreeFilterObjectState) ............................................................. 803
Find(string, Func<DataModelObject, bool>, string, ObjectState) ............................................... 804

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

GetPathToFirstActiveObject() .................................................................................................. 804


Group(IEnumerable<DataModelObject>) ................................................................................ 804
IsSorted() ................................................................................................................................ 805
Refresh() ................................................................................................................................. 805
Sort(SortingType, bool) ........................................................................................................... 805
Suspend() ***OBSOLETE*** Use 'Transaction' instead. .............................................................. 806
TreeGroupingFolder ...................................................................................................................... 806
Children ................................................................................................................................. 806
ChildrenInGroup ..................................................................................................................... 806
DataModelObjectCategory ..................................................................................................... 807
InternalObject ........................................................................................................................ 807
Suppressed ............................................................................................................................ 807
DeleteTreeGroupAndChildren() ............................................................................................... 807
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 807
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 808
Ungroup() .............................................................................................................................. 808
VirtualCell ..................................................................................................................................... 808
Children ................................................................................................................................. 809
Comments .............................................................................................................................. 809
DataModelObjectCategory ..................................................................................................... 809
Figures ................................................................................................................................... 809
Geometry ............................................................................................................................... 810
Images ................................................................................................................................... 810
InternalObject ........................................................................................................................ 810
ProjectToUnderlyingGeometry ................................................................................................ 810
VTClass ................................................................................................................................... 810
AddComment() ....................................................................................................................... 810
AddFigure() ............................................................................................................................ 811
AddImage(string) ................................................................................................................... 811
Delete() .................................................................................................................................. 811
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 811
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 811
VirtualTopology ............................................................................................................................ 812
AspectRatio ............................................................................................................................ 813
AutomaticBehavior ................................................................................................................. 813
Children ................................................................................................................................. 813
Comments .............................................................................................................................. 814
ContactAngle ......................................................................................................................... 814
CustomFeatureAngle .............................................................................................................. 814
DataModelObjectCategory ..................................................................................................... 814
EdgeAngle .............................................................................................................................. 814
Figures ................................................................................................................................... 814
GaussAngle ............................................................................................................................ 815
GenerateOnUpdate ................................................................................................................ 815
Images ................................................................................................................................... 815
InternalObject ........................................................................................................................ 815
LockPositionOfDependentEdgeSplits ...................................................................................... 815
MergeFaceEdges .................................................................................................................... 815
Method .................................................................................................................................. 816
RepairBehavior ....................................................................................................................... 816
SharedBoundaryRatio ............................................................................................................. 816
SimplifyFaces .......................................................................................................................... 816

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

VirtualEdges ........................................................................................................................... 816


VirtualEntities ......................................................................................................................... 816
VirtualFaces ............................................................................................................................ 817
VirtualHardVertex ................................................................................................................... 817
VirtualSplitEdges .................................................................................................................... 817
VirtualSplitFaces ..................................................................................................................... 817
AddComment() ....................................................................................................................... 817
AddFigure() ............................................................................................................................ 817
AddImage(string) ................................................................................................................... 818
Delete() .................................................................................................................................. 818
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 818
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 818
GetVirtualCellFromSelection(ISelectionInfo) ............................................................................ 819
VolumeConstraint ......................................................................................................................... 819
DataModelObjectCategory ..................................................................................................... 820
DefineBy ................................................................................................................................ 820
InternalObject ........................................................................................................................ 820
PercentageToRetain ................................................................................................................ 820
PercentageToRetainMax ......................................................................................................... 820
PercentageToRetainMin .......................................................................................................... 821
ScopingMethod ...................................................................................................................... 821
Worksheet .................................................................................................................................... 821
Ansys.ACT.Automation.Mechanical.MeshControls Namespace ...................................................... 823
AutomaticMethod ........................................................................................................................ 823
Active ..................................................................................................................................... 826
AggressiveInflateOption ......................................................................................................... 826
AggressiveTetImprovement .................................................................................................... 826
Algorithm ............................................................................................................................... 826
ApproximativeNumberOfElementsPerPart .............................................................................. 826
BFCartSubType ....................................................................................................................... 826
BFCartTolerance ..................................................................................................................... 827
ConstrainBoundary ................................................................................................................. 827
ControlMessages .................................................................................................................... 827
CoordinateSystem .................................................................................................................. 827
CornerAngle ........................................................................................................................... 827
CurvatureNormalAngle ........................................................................................................... 827
DataModelObjectCategory ..................................................................................................... 828
DefeatureLayerVolume ........................................................................................................... 828
DefeaturingTolerance ............................................................................................................. 828
DefinedBy .............................................................................................................................. 828
ElementMidsideNodes ***OBSOLETE*** Use the ElementOrder property instead. .................... 828
ElementOption ....................................................................................................................... 828
ElementOrder ......................................................................................................................... 829
FeatureAngle .......................................................................................................................... 829
FreeFaceMeshType ................................................................................................................. 829
FreeMeshType ........................................................................................................................ 829
GenerateLayersUsingFacets .................................................................................................... 829
InflateRelativeTolerance .......................................................................................................... 829
InternalObject ........................................................................................................................ 830
KeyPointsSelection ................................................................................................................. 830
LayerHeight ............................................................................................................................ 830
LayerStart ............................................................................................................................... 830

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

Location ................................................................................................................................. 830


MappedMeshType .................................................................................................................. 830
MatchMeshWherePossible ...................................................................................................... 831
MaximumElementSize ............................................................................................................ 831
MeshBasedDefeaturing ........................................................................................................... 831
MeshInCenter ......................................................................................................................... 831
Method .................................................................................................................................. 831
MinimumEdgeLength ............................................................................................................. 831
MinimumSizeLimit .................................................................................................................. 832
NumberOfCellsAcrossGap ....................................................................................................... 832
OverlappingAngle .................................................................................................................. 832
PreserveBoundaries ................................................................................................................ 832
ProjectCornersToTop .............................................................................................................. 832
ProjectInConstantZPlane ........................................................................................................ 832
ProjectionFactor ..................................................................................................................... 833
Refinement ............................................................................................................................. 833
RelativeTolerance .................................................................................................................... 833
RepairFacets ........................................................................................................................... 833
ReuseBlocking ........................................................................................................................ 833
SlicerFeatureAngle .................................................................................................................. 833
SliverTriangleHeight ............................................................................................................... 834
SmoothTransition ................................................................................................................... 834
SourceLocation ....................................................................................................................... 834
SourceTargetSelection ............................................................................................................ 834
SpacingOption ....................................................................................................................... 834
StretchFactorX ........................................................................................................................ 834
StretchFactorY ........................................................................................................................ 835
StretchFactorZ ........................................................................................................................ 835
SurfaceMeshMethod .............................................................................................................. 835
SweepBiasType ....................................................................................................................... 835
SweepBiasValue ...................................................................................................................... 835
SweepEdges ........................................................................................................................... 835
SweepElementSize ................................................................................................................. 836
SweepESizeType ..................................................................................................................... 836
SweepNumberDivisions .......................................................................................................... 836
SweepSizeBehavior ................................................................................................................. 836
TargetLocation ....................................................................................................................... 836
TetraGrowthRate .................................................................................................................... 836
WriteICEMCFDFiles ................................................................................................................. 837
ContactSizing ............................................................................................................................... 837
ContactRegion ........................................................................................................................ 837
DataModelObjectCategory ..................................................................................................... 838
ElementSize ............................................................................................................................ 838
InternalObject ........................................................................................................................ 838
Relevance ............................................................................................................................... 838
Type ....................................................................................................................................... 838
FaceMeshing ................................................................................................................................ 838
Active ..................................................................................................................................... 839
ConstrainBoundary ................................................................................................................. 839
DataModelObjectCategory ..................................................................................................... 840
InternalNumberOfDivisions .................................................................................................... 840
InternalObject ........................................................................................................................ 840

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

Location ................................................................................................................................. 840


MappedMesh ......................................................................................................................... 840
Method .................................................................................................................................. 840
SpecifiedCorners .................................................................................................................... 841
SpecifiedEnds ......................................................................................................................... 841
SpecifiedSides ........................................................................................................................ 841
Inflation ........................................................................................................................................ 841
Active ..................................................................................................................................... 842
AspectRatio ............................................................................................................................ 842
BoundaryLocation .................................................................................................................. 842
DataModelObjectCategory ..................................................................................................... 843
FirstLayerHeight ..................................................................................................................... 843
GrowthRate ............................................................................................................................ 843
InflationAlgorithm .................................................................................................................. 843
InflationOption ....................................................................................................................... 843
InternalObject ........................................................................................................................ 843
Location ................................................................................................................................. 844
MaximumLayers ..................................................................................................................... 844
MaximumThickness ................................................................................................................ 844
NumberOfLayers .................................................................................................................... 844
TransitionRatio ....................................................................................................................... 844
MatchControl ............................................................................................................................... 844
ControlMessages .................................................................................................................... 845
DataModelObjectCategory ..................................................................................................... 845
HighCoordinateSystem ........................................................................................................... 846
HighGeometrySelection ......................................................................................................... 846
InternalObject ........................................................................................................................ 846
LowCoordinateSystem ............................................................................................................ 846
LowGeometrySelection .......................................................................................................... 846
RotationAxis ........................................................................................................................... 846
Transformation ....................................................................................................................... 847
Mesh ............................................................................................................................................ 847
AspectRatio ............................................................................................................................ 850
AutomaticMeshBasedDefeaturing ........................................................................................... 850
Average .................................................................................................................................. 850
CaptureCurvature ................................................................................................................... 851
CaptureProximity .................................................................................................................... 851
Children ................................................................................................................................. 851
CollisionAvoidance ................................................................................................................. 851
Comments .............................................................................................................................. 851
ConnectionSize ...................................................................................................................... 851
ConnectionTolerance .............................................................................................................. 852
ConnectionToleranceList ......................................................................................................... 852
ConnectionToleranceType ...................................................................................................... 852
CoplanarAngleTol ................................................................................................................... 852
CurvatureNormalAngle ........................................................................................................... 852
DataModelObjectCategory ..................................................................................................... 852
DefeatureTolerance ................................................................................................................ 853
DisplayStyle ............................................................................................................................ 853
ElementOrder ......................................................................................................................... 853
Elements ................................................................................................................................ 853
ElementSize ............................................................................................................................ 853

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

ExportFormat ......................................................................................................................... 853


ExportUnit .............................................................................................................................. 854
ExtraRetriesForAssembly ......................................................................................................... 854
Figures ................................................................................................................................... 854
FilletRatio ............................................................................................................................... 854
FirstLayerHeight ..................................................................................................................... 854
GeneratePinchOnRefresh ........................................................................................................ 854
GrowthRate ............................................................................................................................ 855
GrowthRateSF ........................................................................................................................ 855
GrowthRateType ..................................................................................................................... 855
HoleRemovalTolerance ........................................................................................................... 855
Images ................................................................................................................................... 855
InflationAlgorithm .................................................................................................................. 855
InflationOption ....................................................................................................................... 856
InitialSizeSeed ........................................................................................................................ 856
InternalObject ........................................................................................................................ 856
LocalConnectionOption .......................................................................................................... 856
LocalConnectionTolerance ...................................................................................................... 856
Maximum ............................................................................................................................... 856
MaximumAngle ...................................................................................................................... 857
MaximumHeightOverBase ...................................................................................................... 857
MaximumLayers ..................................................................................................................... 857
MaximumSize ......................................................................................................................... 857
MaximumThickness ................................................................................................................ 857
MeshBasedConnection ........................................................................................................... 857
MeshMetric ............................................................................................................................ 858
MeshMorphing ....................................................................................................................... 858
Method .................................................................................................................................. 858
Minimum ............................................................................................................................... 858
MinimumEdgeLength ............................................................................................................. 858
MinimumSize ......................................................................................................................... 858
MultiConnectionSteps ............................................................................................................ 859
NamedSelection ..................................................................................................................... 859
Nodes ..................................................................................................................................... 859
NumberOfCellsAcrossGap ....................................................................................................... 859
NumberOfCPUsForParallelPartMeshing ................................................................................... 859
NumberOfRetries .................................................................................................................... 859
PhysicsPreference ................................................................................................................... 860
PinchTolerance ....................................................................................................................... 860
ProximityMinimumSize ........................................................................................................... 860
ProximitySizeFunctionSources ................................................................................................ 860
QuadMesh .............................................................................................................................. 860
ReadOnly ................................................................................................................................ 860
Relevance ............................................................................................................................... 861
RelevanceCenter ..................................................................................................................... 861
Resolution .............................................................................................................................. 861
RigidBodyBehavior ................................................................................................................. 861
ShapeChecking ...................................................................................................................... 861
SheetLoopRemoval ................................................................................................................. 861
Smoothing ............................................................................................................................. 862
SmoothingIterations ............................................................................................................... 862
SolverPreference ..................................................................................................................... 862

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

SpanAngleCenter ................................................................................................................... 862


StandardDeviation .................................................................................................................. 862
StraightSidedElements ........................................................................................................... 862
TargetQuality .......................................................................................................................... 863
TargetSkewness ...................................................................................................................... 863
TopologyChecking .................................................................................................................. 863
TransitionOption ..................................................................................................................... 863
TransitionRatio ....................................................................................................................... 863
TriangleSurfaceMesher ........................................................................................................... 863
UseAdaptiveSizing .................................................................................................................. 864
UseAdvancedSizeFunction ...................................................................................................... 864
UseAutomaticInflation ............................................................................................................ 864
UseFixedSizeFunctionForSheets .............................................................................................. 864
UsePostSmoothing ................................................................................................................. 864
UseSheetThicknessForPinch .................................................................................................... 864
ViewAdvancedOptions ........................................................................................................... 865
Worksheet .............................................................................................................................. 865
AddAutomaticMethod() .......................................................................................................... 865
AddComment() ....................................................................................................................... 865
AddContactMatchGroup() ....................................................................................................... 865
AddContactSizing() ................................................................................................................. 865
AddFaceMeshing() .................................................................................................................. 866
AddFigure() ............................................................................................................................ 866
AddImage(string) ................................................................................................................... 866
AddInflation() ......................................................................................................................... 866
AddManualMeshConnection() ................................................................................................ 866
AddMatchControl() ................................................................................................................. 866
AddMeshConnectionGroup() .................................................................................................. 867
AddNodeMerge() .................................................................................................................... 867
AddNodeMergeGroup() .......................................................................................................... 867
AddPinch() ............................................................................................................................. 867
AddRefinement() .................................................................................................................... 867
AddSizing() ............................................................................................................................. 867
ClearGeneratedData() ............................................................................................................. 868
CreatePinchControls() ............................................................................................................. 868
GenerateMesh() ...................................................................................................................... 868
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 868
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 868
PreviewInflation() ................................................................................................................... 869
PreviewSurfaceMesh() ............................................................................................................ 869
ShowMappableBodies() .......................................................................................................... 869
ShowSweepableBodies() ......................................................................................................... 869
Update() ................................................................................................................................. 870
MeshControl ................................................................................................................................. 870
Children ................................................................................................................................. 870
Comments .............................................................................................................................. 871
DataModelObjectCategory ..................................................................................................... 871
Figures ................................................................................................................................... 871
Images ................................................................................................................................... 871
InternalObject ........................................................................................................................ 871
Suppressed ............................................................................................................................ 871
AddComment() ....................................................................................................................... 872

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

AddFigure() ............................................................................................................................ 872


AddImage(string) ................................................................................................................... 872
Delete() .................................................................................................................................. 872
GenerateMesh() ...................................................................................................................... 872
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 872
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 873
Pinch ............................................................................................................................................ 873
AutoManualMode ................................................................................................................... 874
DataModelObjectCategory ..................................................................................................... 874
InternalObject ........................................................................................................................ 874
MasterGeometry ..................................................................................................................... 874
SlaveGeometry ....................................................................................................................... 875
Tolerance ................................................................................................................................ 875
Refinement ................................................................................................................................... 875
DataModelObjectCategory ..................................................................................................... 876
InternalObject ........................................................................................................................ 876
Location ................................................................................................................................. 876
NumberOfRefinements ........................................................................................................... 876
Relevance ..................................................................................................................................... 876
DataModelObjectCategory ..................................................................................................... 877
InternalObject ........................................................................................................................ 877
Location ................................................................................................................................. 877
PartRelavance ......................................................................................................................... 877
Sizing ........................................................................................................................................... 878
Active ..................................................................................................................................... 879
Behavior ................................................................................................................................. 879
BiasFactor ............................................................................................................................... 879
BiasGrowthRate ...................................................................................................................... 879
BiasOption .............................................................................................................................. 879
BiasType ................................................................................................................................. 879
BodyOfInfluence ..................................................................................................................... 880
CurvatureNormalAngle ........................................................................................................... 880
DataModelObjectCategory ..................................................................................................... 880
ElementSize ............................................................................................................................ 880
GrowthRate ............................................................................................................................ 880
InternalObject ........................................................................................................................ 880
LocalMinimumSize ................................................................................................................. 881
Location ................................................................................................................................. 881
NumberOfDivisions ................................................................................................................ 881
OriginX ................................................................................................................................... 881
OriginY ................................................................................................................................... 881
OriginZ ................................................................................................................................... 881
ReverseBias ............................................................................................................................ 882
SphereCenter ......................................................................................................................... 882
SphereRadius ......................................................................................................................... 882
Type ....................................................................................................................................... 882
Ansys.ACT.Automation.Mechanical.Results Namespace ................................................................. 883
Alert ............................................................................................................................................. 883
Children ................................................................................................................................. 884
Comments .............................................................................................................................. 884
DataModelObjectCategory ..................................................................................................... 884
FailsIf ...................................................................................................................................... 885

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

Images ................................................................................................................................... 885


InternalObject ........................................................................................................................ 885
Status ..................................................................................................................................... 885
Value ...................................................................................................................................... 885
AddComment() ....................................................................................................................... 885
AddImage(string) ................................................................................................................... 886
Delete() .................................................................................................................................. 886
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 886
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 886
ContactDataTable ......................................................................................................................... 887
Children ................................................................................................................................. 887
Comments .............................................................................................................................. 888
DataModelObjectCategory ..................................................................................................... 888
Figures ................................................................................................................................... 888
InternalObject ........................................................................................................................ 888
AddComment() ....................................................................................................................... 888
AddFigure() ............................................................................................................................ 888
Delete() .................................................................................................................................. 889
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 889
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 889
Convergence ................................................................................................................................ 889
AllowableChange ................................................................................................................... 890
Children ................................................................................................................................. 890
Comments .............................................................................................................................. 891
DataModelObjectCategory ..................................................................................................... 891
Figures ................................................................................................................................... 891
Images ................................................................................................................................... 891
InternalObject ........................................................................................................................ 891
IsConverged ........................................................................................................................... 891
LastChange ............................................................................................................................ 892
Type ....................................................................................................................................... 892
AddComment() ....................................................................................................................... 892
AddFigure() ............................................................................................................................ 892
AddImage(string) ................................................................................................................... 892
Delete() .................................................................................................................................. 892
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 893
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 893
LatticeDensity .............................................................................................................................. 893
DataModelObjectCategory ..................................................................................................... 895
InternalObject ........................................................................................................................ 895
LatticeElementalDensity ............................................................................................................... 895
DataModelObjectCategory ..................................................................................................... 897
InternalObject ........................................................................................................................ 897
MagneticCoenergy ....................................................................................................................... 897
DataModelObjectCategory ..................................................................................................... 901
InternalObject ........................................................................................................................ 901
MagneticPotential ........................................................................................................................ 901
DataModelObjectCategory ..................................................................................................... 904
InternalObject ........................................................................................................................ 905
NewtonRaphsonResidualForce ...................................................................................................... 905
DataModelObjectCategory ..................................................................................................... 908
InternalObject ........................................................................................................................ 908

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

NewtonRaphsonResidualHeat ....................................................................................................... 908


DataModelObjectCategory ..................................................................................................... 912
InternalObject ........................................................................................................................ 912
NewtonRaphsonResidualMoment ................................................................................................. 912
DataModelObjectCategory ..................................................................................................... 915
InternalObject ........................................................................................................................ 916
Result ........................................................................................................................................... 916
Average .................................................................................................................................. 918
By ........................................................................................................................................... 918
CalculateTimeHistory .............................................................................................................. 918
Children ................................................................................................................................. 918
CombinationNumber .............................................................................................................. 919
Comments .............................................................................................................................. 919
CoordinateSystem .................................................................................................................. 919
DataModelObjectCategory ..................................................................................................... 919
DisplayOption ........................................................................................................................ 919
DisplayTime ............................................................................................................................ 919
Figures ................................................................................................................................... 920
GraphControlsXAxis ................................................................................................................ 920
Identifier ................................................................................................................................ 920
Images ................................................................................................................................... 920
InternalObject ........................................................................................................................ 920
IsSolved .................................................................................................................................. 920
ItemType ................................................................................................................................ 921
IterationNumber ..................................................................................................................... 921
LoadStep ................................................................................................................................ 921
LoadStepForMaximumOfMaximumValues ............................................................................... 921
LoadStepForMaximumOfMinimumValues ............................................................................... 921
LoadStepForMinimumOfMaximumValues ............................................................................... 921
LoadStepForMinimumOfMinimumValues ................................................................................ 922
Location ................................................................................................................................. 922
Maximum ............................................................................................................................... 922
MaximumOccursOn ................................................................................................................ 922
MaximumOfMaximumOverTime ............................................................................................. 922
MaximumOfMinimumOverTime ............................................................................................. 922
Minimum ............................................................................................................................... 923
MinimumOccursOn ................................................................................................................ 923
MinimumOfMaximumOverTime ............................................................................................. 923
MinimumOfMinimumOverTime .............................................................................................. 923
PlotData ................................................................................................................................. 923
RpmSetNumber ...................................................................................................................... 923
ScopingMethod ...................................................................................................................... 924
SetNumber ............................................................................................................................. 924
SolutionCombinationDriver .................................................................................................... 924
SolverComponentIDs .............................................................................................................. 924
Substep .................................................................................................................................. 924
Suppressed ............................................................................................................................ 924
TabularData ............................................................................................................................ 925
Time ....................................................................................................................................... 925
TimeForMaximumOfMaximumValues ..................................................................................... 925
TimeForMaximumOfMinimumValues ...................................................................................... 925
TimeForMinimumOfMaximumValues ...................................................................................... 925

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

TimeForMinimumOfMinimumValues ....................................................................................... 925


AddAlert() .............................................................................................................................. 926
AddComment() ....................................................................................................................... 926
AddConvergence() .................................................................................................................. 926
AddFigure() ............................................................................................................................ 926
AddImage(string) ................................................................................................................... 926
ClearGeneratedData() ............................................................................................................. 927
CreateResultsAtAllSets() .......................................................................................................... 927
Delete() .................................................................................................................................. 927
DuplicateWithoutResults() ...................................................................................................... 927
EvaluateAllResults() ................................................................................................................. 927
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) .............. 927
ExportToTextFile(string) .......................................................................................................... 928
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 928
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 928
PromoteToNamedSelection() .................................................................................................. 929
ResultChart ................................................................................................................................... 929
AccelerationType .................................................................................................................... 931
BoundaryCondition ................................................................................................................ 931
ChartViewingStyle .................................................................................................................. 931
Children ................................................................................................................................. 931
Comments .............................................................................................................................. 931
CoordinateSystem .................................................................................................................. 931
CurvesAppearanceDisplay ...................................................................................................... 932
CutFrequency ......................................................................................................................... 932
DataModelObjectCategory ..................................................................................................... 932
DeformationType ................................................................................................................... 932
Duration ................................................................................................................................. 932
EnhancedTracking .................................................................................................................. 932
FilterMaximum ....................................................................................................................... 933
FilterMinimum ........................................................................................................................ 933
FilterType ............................................................................................................................... 933
FrequencyAtMaximumAmplitude ........................................................................................... 933
GeometrySelectionString ........................................................................................................ 933
Images ................................................................................................................................... 933
ImaginaryAtMaximumAmplitude ............................................................................................ 934
InternalObject ........................................................................................................................ 934
IsSolved .................................................................................................................................. 934
Location ................................................................................................................................. 934
Maximum ............................................................................................................................... 934
MaximumAmplitude ............................................................................................................... 934
MaximumFrequency ............................................................................................................... 935
Minimum ............................................................................................................................... 935
MinimumFrequency ............................................................................................................... 935
NormalOrientation ................................................................................................................. 935
PhaseAngle ............................................................................................................................ 935
RealAtMaximumAmplitude ..................................................................................................... 935
ReportedFrequency ................................................................................................................ 936
RequestedFrequency .............................................................................................................. 936
ResultChartType ..................................................................................................................... 936
RpmSetNumber ...................................................................................................................... 936
ShearOrientation .................................................................................................................... 936

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

SpatialResolution .................................................................................................................... 936


Spring .................................................................................................................................... 937
StressStrainType ..................................................................................................................... 937
Suppressed ............................................................................................................................ 937
TimeHistoryDisplay ................................................................................................................. 937
UseParentFrequencyRange ..................................................................................................... 937
VelocityType ........................................................................................................................... 937
XAxisValues ............................................................................................................................ 938
AddComment() ....................................................................................................................... 938
AddImage(string) ................................................................................................................... 938
Delete() .................................................................................................................................. 938
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) .............. 938
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 939
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 939
ResultTable ................................................................................................................................... 939
Children ................................................................................................................................. 940
Comments .............................................................................................................................. 940
DataModelObjectCategory ..................................................................................................... 940
Images ................................................................................................................................... 941
InternalObject ........................................................................................................................ 941
Multiplier ................................................................................................................................ 941
AddComment() ....................................................................................................................... 941
AddImage(string) ................................................................................................................... 941
Delete() .................................................................................................................................. 941
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 942
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 942
ShapeFinder ................................................................................................................................. 942
DataModelObjectCategory ..................................................................................................... 946
InternalObject ........................................................................................................................ 946
ShapeFinderElemental .................................................................................................................. 946
DataModelObjectCategory ..................................................................................................... 949
InternalObject ........................................................................................................................ 950
Smoothing ................................................................................................................................... 950
DataModelObjectCategory ..................................................................................................... 951
InternalObject ........................................................................................................................ 951
MoveLimit .............................................................................................................................. 951
TopologyDensity .......................................................................................................................... 951
DataModelObjectCategory ..................................................................................................... 953
InternalObject ........................................................................................................................ 953
RetainedThreshold ................................................................................................................. 953
InsertSmoothing() .................................................................................................................. 954
TopologyElementalDensity ........................................................................................................... 954
DataModelObjectCategory ..................................................................................................... 955
InternalObject ........................................................................................................................ 956
RetainedThreshold ................................................................................................................. 956
TopologyOptimizationResult ......................................................................................................... 956
Children ................................................................................................................................. 957
Comments .............................................................................................................................. 957
DataModelObjectCategory ..................................................................................................... 957
ExclusionsParticipation ........................................................................................................... 957
Figures ................................................................................................................................... 958
FinalMass ............................................................................................................................... 958

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

FinalVolume ........................................................................................................................... 958


Images ................................................................................................................................... 958
InternalObject ........................................................................................................................ 958
IterationNumber ..................................................................................................................... 958
Location ................................................................................................................................. 959
Maximum ............................................................................................................................... 959
Minimum ............................................................................................................................... 959
OriginalMass .......................................................................................................................... 959
OriginalVolume ...................................................................................................................... 959
PercentMassOfOriginal ........................................................................................................... 959
PercentVolumeOfOriginal ....................................................................................................... 960
ShowOptimizedRegion ........................................................................................................... 960
Suppressed ............................................................................................................................ 960
AddComment() ....................................................................................................................... 960
AddFigure() ............................................................................................................................ 960
AddImage(string) ................................................................................................................... 960
ClearGeneratedData() ............................................................................................................. 961
Delete() .................................................................................................................................. 961
EvaluateAllResults() ................................................................................................................. 961
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) .............. 961
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 962
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 962
UserDefinedResult ........................................................................................................................ 962
Average .................................................................................................................................. 964
AverageAcrossBodies .............................................................................................................. 964
By ........................................................................................................................................... 965
CalculateTimeHistory .............................................................................................................. 965
Children ................................................................................................................................. 965
CombinationNumber .............................................................................................................. 965
CoordinateSystem .................................................................................................................. 965
CyclicMode ............................................................................................................................. 965
DataModelObjectCategory ..................................................................................................... 966
DisplayOption ........................................................................................................................ 966
DisplayTime ............................................................................................................................ 966
Expression .............................................................................................................................. 966
GraphControlsXAxis ................................................................................................................ 966
Identifier ................................................................................................................................ 966
InputUnitSystem ..................................................................................................................... 967
InternalObject ........................................................................................................................ 967
IsSolved .................................................................................................................................. 967
ItemType ................................................................................................................................ 967
IterationNumber ..................................................................................................................... 967
Layer ...................................................................................................................................... 967
LoadMultiplier ........................................................................................................................ 968
LoadStep ................................................................................................................................ 968
Location ................................................................................................................................. 968
Maximum ............................................................................................................................... 968
MaximumOccursOn ................................................................................................................ 968
MaximumOfMaximumOverTime ............................................................................................. 968
MaximumOfMinimumOverTime ............................................................................................. 969
Minimum ............................................................................................................................... 969
MinimumOccursOn ................................................................................................................ 969

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

MinimumOfMaximumOverTime ............................................................................................. 969


MinimumOfMinimumOverTime .............................................................................................. 969
Mode ..................................................................................................................................... 969
OutputUnit ............................................................................................................................. 970
PlotData ................................................................................................................................. 970
Ply .......................................................................................................................................... 970
Position .................................................................................................................................. 970
ReportedFrequency ................................................................................................................ 970
RequestedFrequency .............................................................................................................. 970
ResponseType ........................................................................................................................ 971
RpmSetNumber ...................................................................................................................... 971
ScaleFactor ............................................................................................................................. 971
ScaleFactorValue ..................................................................................................................... 971
ScopingMethod ...................................................................................................................... 971
SetNumber ............................................................................................................................. 971
SolutionCombinationDriver .................................................................................................... 972
SolverComponentIDs .............................................................................................................. 972
SubScopeBy ........................................................................................................................... 972
Substep .................................................................................................................................. 972
Suppressed ............................................................................................................................ 972
SweepingPhase ...................................................................................................................... 972
Time ....................................................................................................................................... 973
Type ....................................................................................................................................... 973
ClearGeneratedData() ............................................................................................................. 973
CreateResultsAtAllSets() .......................................................................................................... 973
Delete() .................................................................................................................................. 973
DuplicateWithoutResults() ...................................................................................................... 973
EvaluateAllResults() ................................................................................................................. 974
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) .............. 974
ExportToTextFile(string) .......................................................................................................... 974
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 974
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) .................................. 975
PromoteToNamedSelection() .................................................................................................. 975
VariableGraph ............................................................................................................................... 975
DataModelObjectCategory ..................................................................................................... 979
InternalObject ........................................................................................................................ 979
Volume ......................................................................................................................................... 979
DataModelObjectCategory ..................................................................................................... 982
InternalObject ........................................................................................................................ 983
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace ........................... 985
AccelerationPhaseResponse .......................................................................................................... 985
ContactRegion ........................................................................................................................ 988
DataModelObjectCategory ..................................................................................................... 988
InternalObject ........................................................................................................................ 988
DeformationPhaseResponse ......................................................................................................... 988
DataModelObjectCategory ..................................................................................................... 991
InternalObject ........................................................................................................................ 991
ElasticStrainPhaseResponse .......................................................................................................... 992
ContactRegion ........................................................................................................................ 994
DataModelObjectCategory ..................................................................................................... 994
InternalObject ........................................................................................................................ 995
StressPhaseResponse .................................................................................................................... 995

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

DataModelObjectCategory ..................................................................................................... 998


InternalObject ........................................................................................................................ 998
VelocityPhaseResponse ................................................................................................................ 998
ContactRegion ...................................................................................................................... 1001
DataModelObjectCategory ................................................................................................... 1001
InternalObject ...................................................................................................................... 1001
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace ......................................... 1003
AccumulatedEquivalentPlasticStrain ........................................................................................... 1003
DataModelObjectCategory ................................................................................................... 1008
InternalObject ...................................................................................................................... 1008
DirectionalThermalStrain ............................................................................................................ 1008
DataModelObjectCategory ................................................................................................... 1012
InternalObject ...................................................................................................................... 1012
NormalOrientation ................................................................................................................ 1012
ElasticStrainIntensity ................................................................................................................... 1013
DataModelObjectCategory ................................................................................................... 1017
InternalObject ...................................................................................................................... 1017
EquivalentCreepStrain ................................................................................................................ 1017
DataModelObjectCategory ................................................................................................... 1021
InternalObject ...................................................................................................................... 1021
EquivalentCreepStrainRST ........................................................................................................... 1021
DataModelObjectCategory ................................................................................................... 1026
InternalObject ...................................................................................................................... 1026
EquivalentElasticStrain ................................................................................................................ 1026
DataModelObjectCategory ................................................................................................... 1030
InternalObject ...................................................................................................................... 1030
EquivalentElasticStrainRST .......................................................................................................... 1030
DataModelObjectCategory ................................................................................................... 1035
InternalObject ...................................................................................................................... 1035
EquivalentPlasticStrain ................................................................................................................ 1035
DataModelObjectCategory ................................................................................................... 1039
InternalObject ...................................................................................................................... 1039
EquivalentPlasticStrainRST .......................................................................................................... 1039
DataModelObjectCategory ................................................................................................... 1044
InternalObject ...................................................................................................................... 1044
EquivalentTotalStrain .................................................................................................................. 1044
DataModelObjectCategory ................................................................................................... 1048
InternalObject ...................................................................................................................... 1048
MaximumPrincipalElasticStrain ................................................................................................... 1048
DataModelObjectCategory ................................................................................................... 1053
InternalObject ...................................................................................................................... 1053
Layer .................................................................................................................................... 1053
NormalOrientation ................................................................................................................ 1053
MaximumPrincipalThermalStrain ................................................................................................ 1053
DataModelObjectCategory ................................................................................................... 1057
InternalObject ...................................................................................................................... 1058
MaximumShearElasticStrain ........................................................................................................ 1058
DataModelObjectCategory ................................................................................................... 1062
InternalObject ...................................................................................................................... 1062
ShearOrientation .................................................................................................................. 1062
MiddlePrincipalElasticStrain ........................................................................................................ 1062
DataModelObjectCategory ................................................................................................... 1067

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

InternalObject ...................................................................................................................... 1067


MiddlePrincipalThermalStrain ..................................................................................................... 1067
DataModelObjectCategory ................................................................................................... 1071
InternalObject ...................................................................................................................... 1071
MinimumPrincipalElasticStrain .................................................................................................... 1071
DataModelObjectCategory ................................................................................................... 1076
InternalObject ...................................................................................................................... 1076
NormalElasticStrain ..................................................................................................................... 1076
DataModelObjectCategory ................................................................................................... 1080
InternalObject ...................................................................................................................... 1080
NormalOrientation ................................................................................................................ 1080
ScaleFactor ........................................................................................................................... 1081
ScaleFactorValue ................................................................................................................... 1081
ShearElasticStrain ....................................................................................................................... 1081
DataModelObjectCategory ................................................................................................... 1085
InternalObject ...................................................................................................................... 1085
ScaleFactor ........................................................................................................................... 1086
ScaleFactorValue ................................................................................................................... 1086
ShearOrientation .................................................................................................................. 1086
StrainResult ................................................................................................................................ 1086
Amplitude ............................................................................................................................ 1090
AverageAcrossBodies ............................................................................................................ 1090
CyclicMode ........................................................................................................................... 1090
DataModelObjectCategory ................................................................................................... 1090
Frequency ............................................................................................................................ 1090
HarmonicIndex ..................................................................................................................... 1091
InternalObject ...................................................................................................................... 1091
LoadMultiplier ...................................................................................................................... 1091
Mode .................................................................................................................................... 1091
PhaseIncrement .................................................................................................................... 1091
Ply ........................................................................................................................................ 1091
Position ................................................................................................................................ 1092
ReportedFrequency .............................................................................................................. 1092
StressStrainType ................................................................................................................... 1092
SubScopeBy ......................................................................................................................... 1092
SweepingPhase .................................................................................................................... 1092
VectorPrincipalElasticStrain ......................................................................................................... 1092
DataModelObjectCategory ................................................................................................... 1097
InternalObject ...................................................................................................................... 1097
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace .............................. 1099
DeformationResult ...................................................................................................................... 1099
AccelerationInG .................................................................................................................... 1103
AllowPhaseSweep ................................................................................................................. 1103
Amplitude ............................................................................................................................ 1103
CyclicMode ........................................................................................................................... 1104
CyclicPhase ........................................................................................................................... 1104
DampedFrequency ............................................................................................................... 1104
DataModelObjectCategory ................................................................................................... 1104
DeformationType .................................................................................................................. 1104
Frequency ............................................................................................................................ 1104
HarmonicIndex ..................................................................................................................... 1105
InternalObject ...................................................................................................................... 1105

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

LoadMultiplier ...................................................................................................................... 1105


LogarithmicDecrement ......................................................................................................... 1105
ModalDampingRatio ............................................................................................................. 1105
Mode .................................................................................................................................... 1105
PhaseIncrement .................................................................................................................... 1106
Probability ............................................................................................................................ 1106
Reference ............................................................................................................................. 1106
ReportedFrequency .............................................................................................................. 1106
ScaleFactor ........................................................................................................................... 1106
ScaleFactorValue ................................................................................................................... 1106
Stability ................................................................................................................................ 1107
SweepingPhase .................................................................................................................... 1107
DirectionalAcceleration ............................................................................................................... 1107
DataModelObjectCategory ................................................................................................... 1111
InternalObject ...................................................................................................................... 1112
NormalOrientation ................................................................................................................ 1112
DirectionalAccelerationPSD ........................................................................................................ 1112
DataModelObjectCategory ................................................................................................... 1117
InternalObject ...................................................................................................................... 1117
NormalOrientation ................................................................................................................ 1117
DirectionalAccelerationRS ........................................................................................................... 1117
DataModelObjectCategory ................................................................................................... 1122
InternalObject ...................................................................................................................... 1122
NormalOrientation ................................................................................................................ 1122
DirectionalDeformation .............................................................................................................. 1122
DataModelObjectCategory ................................................................................................... 1127
InternalObject ...................................................................................................................... 1127
NormalOrientation ................................................................................................................ 1127
DirectionalVelocity ...................................................................................................................... 1127
DataModelObjectCategory ................................................................................................... 1132
InternalObject ...................................................................................................................... 1132
NormalOrientation ................................................................................................................ 1132
DirectionalVelocityPSD ............................................................................................................... 1132
DataModelObjectCategory ................................................................................................... 1137
InternalObject ...................................................................................................................... 1137
NormalOrientation ................................................................................................................ 1137
DirectionalVelocityRS .................................................................................................................. 1137
DataModelObjectCategory ................................................................................................... 1142
InternalObject ...................................................................................................................... 1142
NormalOrientation ................................................................................................................ 1142
TotalAcceleration ........................................................................................................................ 1143
DataModelObjectCategory ................................................................................................... 1147
InternalObject ...................................................................................................................... 1147
TotalDeformation ....................................................................................................................... 1147
DataModelObjectCategory ................................................................................................... 1152
InternalObject ...................................................................................................................... 1152
TotalVelocity ............................................................................................................................... 1152
DataModelObjectCategory ................................................................................................... 1157
InternalObject ...................................................................................................................... 1157
VectorDeformation ..................................................................................................................... 1157
DataModelObjectCategory ................................................................................................... 1161
InternalObject ...................................................................................................................... 1161

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

Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace ..................................... 1163


DamageResult ............................................................................................................................ 1163
DamageResultType ............................................................................................................... 1167
DataModelObjectCategory ................................................................................................... 1167
InternalObject ...................................................................................................................... 1167
Mode .................................................................................................................................... 1167
Surface ................................................................................................................................. 1167
DamageStatus ............................................................................................................................ 1167
DataModelObjectCategory ................................................................................................... 1171
InternalObject ...................................................................................................................... 1171
EnergyDissipatedPerUnitVolume ................................................................................................. 1171
DataModelObjectCategory ................................................................................................... 1175
InternalObject ...................................................................................................................... 1175
FiberCompressiveDamageVariable .............................................................................................. 1175
DataModelObjectCategory ................................................................................................... 1179
InternalObject ...................................................................................................................... 1179
FiberCompressiveFailureCriterion ................................................................................................ 1179
DataModelObjectCategory ................................................................................................... 1182
InternalObject ...................................................................................................................... 1183
FiberTensileDamageVariable ....................................................................................................... 1183
DataModelObjectCategory ................................................................................................... 1186
InternalObject ...................................................................................................................... 1186
FiberTensileFailureCriterion ......................................................................................................... 1187
DataModelObjectCategory ................................................................................................... 1190
InternalObject ...................................................................................................................... 1190
MatrixCompressiveDamageVariable ............................................................................................ 1190
DataModelObjectCategory ................................................................................................... 1194
InternalObject ...................................................................................................................... 1194
MatrixCompressiveFailureCriterion .............................................................................................. 1194
DataModelObjectCategory ................................................................................................... 1198
InternalObject ...................................................................................................................... 1198
MatrixTensileDamageVariable ..................................................................................................... 1198
DataModelObjectCategory ................................................................................................... 1202
InternalObject ...................................................................................................................... 1202
MatrixTensileFailureCriterion ....................................................................................................... 1202
DataModelObjectCategory ................................................................................................... 1205
InternalObject ...................................................................................................................... 1206
MaximumFailureCriteria .............................................................................................................. 1206
DataModelObjectCategory ................................................................................................... 1209
InternalObject ...................................................................................................................... 1209
MullinsDamageVariable .............................................................................................................. 1210
DataModelObjectCategory ................................................................................................... 1213
InternalObject ...................................................................................................................... 1213
MullinsMaximumPreviousStrainEnergy ....................................................................................... 1213
DataModelObjectCategory ................................................................................................... 1217
InternalObject ...................................................................................................................... 1217
ShearDamageVariable ................................................................................................................. 1217
DataModelObjectCategory ................................................................................................... 1221
InternalObject ...................................................................................................................... 1221
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace ................... 1223
CoordinateSystemsResult ............................................................................................................ 1223
Amplitude ............................................................................................................................ 1227

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

DataModelObjectCategory ................................................................................................... 1227


Frequency ............................................................................................................................ 1227
InternalObject ...................................................................................................................... 1227
LoadMultiplier ...................................................................................................................... 1227
Mode .................................................................................................................................... 1228
Ply ........................................................................................................................................ 1228
Position ................................................................................................................................ 1228
ScaleFactor ........................................................................................................................... 1228
ScaleFactorValue ................................................................................................................... 1228
SubScopeBy ......................................................................................................................... 1228
SweepingPhase .................................................................................................................... 1229
ElementalEulerXYAngle ............................................................................................................... 1229
DataModelObjectCategory ................................................................................................... 1233
InternalObject ...................................................................................................................... 1233
ElementalEulerXZAngle .............................................................................................................. 1233
DataModelObjectCategory ................................................................................................... 1237
InternalObject ...................................................................................................................... 1237
ElementalEulerYZAngle .............................................................................................................. 1238
DataModelObjectCategory ................................................................................................... 1242
InternalObject ...................................................................................................................... 1242
ElementalTriads .......................................................................................................................... 1242
DataModelObjectCategory ................................................................................................... 1246
InternalObject ...................................................................................................................... 1246
NodalEulerXYAngle ..................................................................................................................... 1246
DataModelObjectCategory ................................................................................................... 1251
InternalObject ...................................................................................................................... 1251
NodalEulerXZAngle .................................................................................................................... 1251
DataModelObjectCategory ................................................................................................... 1255
InternalObject ...................................................................................................................... 1255
NodalEulerYZAngle ..................................................................................................................... 1255
DataModelObjectCategory ................................................................................................... 1259
InternalObject ...................................................................................................................... 1260
NodalTriads ................................................................................................................................ 1260
DataModelObjectCategory ................................................................................................... 1264
InternalObject ...................................................................................................................... 1264
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace ..................................... 1265
DirectionalHeatFlux .................................................................................................................... 1265
DataModelObjectCategory ................................................................................................... 1269
InternalObject ...................................................................................................................... 1269
DirectionalThermalHeatFlux ........................................................................................................ 1269
DataModelObjectCategory ................................................................................................... 1273
InternalObject ...................................................................................................................... 1273
FluidFlowRate ............................................................................................................................. 1273
DataModelObjectCategory ................................................................................................... 1277
InternalObject ...................................................................................................................... 1277
FluidHeatConductionRate ........................................................................................................... 1277
DataModelObjectCategory ................................................................................................... 1281
InternalObject ...................................................................................................................... 1281
FluidHeatTransportRate .............................................................................................................. 1281
DataModelObjectCategory ................................................................................................... 1285
InternalObject ...................................................................................................................... 1285
TemperatureResult ..................................................................................................................... 1285

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

DataModelObjectCategory ................................................................................................... 1289


InternalObject ...................................................................................................................... 1289
ThermalError .............................................................................................................................. 1289
DataModelObjectCategory ................................................................................................... 1293
InternalObject ...................................................................................................................... 1293
ThermalResult ............................................................................................................................ 1293
AverageAcrossBodies ............................................................................................................ 1296
DataModelObjectCategory ................................................................................................... 1296
InternalObject ...................................................................................................................... 1297
Layer .................................................................................................................................... 1297
NormalOrientation ................................................................................................................ 1297
Position ................................................................................................................................ 1297
ThermalResultType ............................................................................................................... 1297
TotalHeatFlux ............................................................................................................................. 1297
DataModelObjectCategory ................................................................................................... 1301
InternalObject ...................................................................................................................... 1301
VectorHeatFlux ........................................................................................................................... 1301
DataModelObjectCategory ................................................................................................... 1305
InternalObject ...................................................................................................................... 1305
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace .................................. 1307
StressRatio .................................................................................................................................. 1307
DataModelObjectCategory ................................................................................................... 1310
InternalObject ...................................................................................................................... 1311
StressSafetyFactor ....................................................................................................................... 1311
DataModelObjectCategory ................................................................................................... 1314
InternalObject ...................................................................................................................... 1314
StressSafetyMargin ..................................................................................................................... 1314
DataModelObjectCategory ................................................................................................... 1318
InternalObject ...................................................................................................................... 1318
StressTool ................................................................................................................................... 1318
Children ............................................................................................................................... 1319
Comments ............................................................................................................................ 1319
CompressiveLimit ................................................................................................................. 1319
CompressiveLimitType .......................................................................................................... 1320
DataModelObjectCategory ................................................................................................... 1320
Figures ................................................................................................................................. 1320
Images ................................................................................................................................. 1320
InternalObject ...................................................................................................................... 1320
LimitFactor ........................................................................................................................... 1320
StressLimit ............................................................................................................................ 1321
StressLimitType .................................................................................................................... 1321
TensileLimit .......................................................................................................................... 1321
TensileLimitType ................................................................................................................... 1321
Theory .................................................................................................................................. 1321
AddComment() ..................................................................................................................... 1321
AddFigure() .......................................................................................................................... 1322
AddImage(string) .................................................................................................................. 1322
AddSafetyFactor() ................................................................................................................. 1322
AddSafetyMargin() ................................................................................................................ 1322
AddStressRatio() ................................................................................................................... 1322
Delete() ................................................................................................................................ 1322
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1323

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

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 1323


StressToolResult .......................................................................................................................... 1323
AverageAcrossBodies ............................................................................................................ 1327
DataModelObjectCategory ................................................................................................... 1327
InternalObject ...................................................................................................................... 1327
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace ........................ 1329
LinearizedEquivalentStress .......................................................................................................... 1329
DataModelObjectCategory ................................................................................................... 1334
InternalObject ...................................................................................................................... 1335
LinearizedMaximumPrincipalStress ............................................................................................. 1335
DataModelObjectCategory ................................................................................................... 1340
InternalObject ...................................................................................................................... 1340
LinearizedMaximumShearStress .................................................................................................. 1340
DataModelObjectCategory ................................................................................................... 1346
InternalObject ...................................................................................................................... 1346
ShearOrientation .................................................................................................................. 1346
LinearizedMiddlePrincipalStress .................................................................................................. 1346
DataModelObjectCategory ................................................................................................... 1351
InternalObject ...................................................................................................................... 1351
LinearizedMinimumPrincipalStress .............................................................................................. 1352
DataModelObjectCategory ................................................................................................... 1357
InternalObject ...................................................................................................................... 1357
LinearizedNormalStress .............................................................................................................. 1357
DataModelObjectCategory ................................................................................................... 1363
InternalObject ...................................................................................................................... 1363
LinearizedShearStress ................................................................................................................. 1363
DataModelObjectCategory ................................................................................................... 1368
InternalObject ...................................................................................................................... 1368
ShearOrientation .................................................................................................................. 1368
LinearizedStressIntensity ............................................................................................................. 1369
DataModelObjectCategory ................................................................................................... 1374
InternalObject ...................................................................................................................... 1374
LinearizedStressResult ................................................................................................................ 1374
Amplitude ............................................................................................................................ 1378
AverageRadiusOfCurvature ................................................................................................... 1378
BendingInside ...................................................................................................................... 1378
BendingOutside .................................................................................................................... 1379
DataModelObjectCategory ................................................................................................... 1379
Frequency ............................................................................................................................ 1379
InternalObject ...................................................................................................................... 1379
Linearized2DBehavior ........................................................................................................... 1379
LoadMultiplier ...................................................................................................................... 1379
Membrane ............................................................................................................................ 1380
MembraneBendingCenter ..................................................................................................... 1380
MembraneBendingInside ...................................................................................................... 1380
MembraneBendingOutside ................................................................................................... 1380
NormalOrientation ................................................................................................................ 1380
PeakCenter ........................................................................................................................... 1380
PeakInside ............................................................................................................................ 1381
PeakOutside ......................................................................................................................... 1381
Position ................................................................................................................................ 1381
StressStrainType ................................................................................................................... 1381

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

Subtype ................................................................................................................................ 1381


Surface ................................................................................................................................. 1381
SweepingPhase .................................................................................................................... 1382
ThroughThicknessBendingStress ........................................................................................... 1382
TotalCenter ........................................................................................................................... 1382
TotalInside ............................................................................................................................ 1382
TotalOutside ......................................................................................................................... 1382
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace ....................................... 1383
GasketResult ............................................................................................................................... 1383
DataModelObjectCategory ................................................................................................... 1386
GasketResultType ................................................................................................................. 1387
InternalObject ...................................................................................................................... 1387
NormalGasketPressure ................................................................................................................ 1387
DataModelObjectCategory ................................................................................................... 1390
InternalObject ...................................................................................................................... 1390
NormalGasketTotalClosure .......................................................................................................... 1391
DataModelObjectCategory ................................................................................................... 1394
InternalObject ...................................................................................................................... 1394
ShearGasketPressure ................................................................................................................... 1394
DataModelObjectCategory ................................................................................................... 1398
InternalObject ...................................................................................................................... 1398
ShearOrientation .................................................................................................................. 1398
ShearGasketTotalClosure ............................................................................................................ 1398
DataModelObjectCategory ................................................................................................... 1402
InternalObject ...................................................................................................................... 1402
ShearOrientation .................................................................................................................. 1402
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace ....................................... 1403
ElementalStrainEnergy ................................................................................................................ 1403
DataModelObjectCategory ................................................................................................... 1406
InternalObject ...................................................................................................................... 1407
EnergyResult .............................................................................................................................. 1407
DataModelObjectCategory ................................................................................................... 1410
InternalObject ...................................................................................................................... 1410
StabilizationEnergy ..................................................................................................................... 1410
DataModelObjectCategory ................................................................................................... 1414
InternalObject ...................................................................................................................... 1414
StructuralStrainEnergy ................................................................................................................ 1414
DataModelObjectCategory ................................................................................................... 1417
InternalObject ...................................................................................................................... 1418
ThermalStrainEnergy .................................................................................................................. 1418
DataModelObjectCategory ................................................................................................... 1421
InternalObject ...................................................................................................................... 1421
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace ........................ 1423
CurrentDensity ........................................................................................................................... 1423
DataModelObjectCategory ................................................................................................... 1427
InternalObject ...................................................................................................................... 1427
DirectionalMagneticFieldIntensity ............................................................................................... 1427
DataModelObjectCategory ................................................................................................... 1431
InternalObject ...................................................................................................................... 1431
NormalOrientation ................................................................................................................ 1431
DirectionalMagneticFluxDensity ................................................................................................. 1431
DataModelObjectCategory ................................................................................................... 1435

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

InternalObject ...................................................................................................................... 1435


NormalOrientation ................................................................................................................ 1435
ElectricPotential .......................................................................................................................... 1435
DataModelObjectCategory ................................................................................................... 1439
InternalObject ...................................................................................................................... 1439
ElectromagneticResult ................................................................................................................ 1439
AverageAcrossBodies ............................................................................................................ 1442
DataModelObjectCategory ................................................................................................... 1442
ElectromagneticResultType ................................................................................................... 1443
InternalObject ...................................................................................................................... 1443
FluxLinkage ................................................................................................................................ 1443
DataModelObjectCategory ................................................................................................... 1444
InternalObject ...................................................................................................................... 1444
Inductance ................................................................................................................................. 1444
DataModelObjectCategory ................................................................................................... 1444
InternalObject ...................................................................................................................... 1445
MagneticDirectionalForces .......................................................................................................... 1445
DataModelObjectCategory ................................................................................................... 1448
InternalObject ...................................................................................................................... 1448
NormalOrientation ................................................................................................................ 1449
MagneticError ............................................................................................................................. 1449
DataModelObjectCategory ................................................................................................... 1452
InternalObject ...................................................................................................................... 1452
MagneticTotalForces ................................................................................................................... 1453
DataModelObjectCategory ................................................................................................... 1456
InternalObject ...................................................................................................................... 1456
Total ..................................................................................................................................... 1456
TotalMagneticFieldIntensity ........................................................................................................ 1457
DataModelObjectCategory ................................................................................................... 1460
InternalObject ...................................................................................................................... 1460
TotalMagneticFluxDensity ........................................................................................................... 1460
DataModelObjectCategory ................................................................................................... 1464
InternalObject ...................................................................................................................... 1464
Ansys.ACT.Automation.Mechanical.Results.ElectricResults Namespace ....................................... 1465
DirectionalCurrentDensity .......................................................................................................... 1465
DataModelObjectCategory ................................................................................................... 1468
InternalObject ...................................................................................................................... 1469
NormalOrientation ................................................................................................................ 1469
DirectionalElectricFieldIntensity .................................................................................................. 1469
DataModelObjectCategory ................................................................................................... 1472
InternalObject ...................................................................................................................... 1473
NormalOrientation ................................................................................................................ 1473
ElectricResult .............................................................................................................................. 1473
AverageAcrossBodies ............................................................................................................ 1476
DataModelObjectCategory ................................................................................................... 1476
ElectricResultType ................................................................................................................. 1477
InternalObject ...................................................................................................................... 1477
ElectricVoltage ............................................................................................................................ 1477
DataModelObjectCategory ................................................................................................... 1480
InternalObject ...................................................................................................................... 1481
JouleHeat ................................................................................................................................... 1481
DataModelObjectCategory ................................................................................................... 1484

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

InternalObject ...................................................................................................................... 1484


TotalCurrentDensity .................................................................................................................... 1484
DataModelObjectCategory ................................................................................................... 1488
InternalObject ...................................................................................................................... 1488
TotalElectricFieldIntensity ........................................................................................................... 1488
DataModelObjectCategory ................................................................................................... 1492
InternalObject ...................................................................................................................... 1492
Ansys.ACT.Automation.Mechanical.Results.ContactToolResults Namespace ............................... 1493
ContactFluidPressure .................................................................................................................. 1493
DataModelObjectCategory ................................................................................................... 1497
InternalObject ...................................................................................................................... 1497
ContactFrictionalStress ............................................................................................................... 1497
DataModelObjectCategory ................................................................................................... 1500
InternalObject ...................................................................................................................... 1500
ContactGap ................................................................................................................................ 1501
DataModelObjectCategory ................................................................................................... 1504
InternalObject ...................................................................................................................... 1504
ContactHeatFlux ......................................................................................................................... 1504
DataModelObjectCategory ................................................................................................... 1508
InternalObject ...................................................................................................................... 1508
ContactPenetration ..................................................................................................................... 1508
DataModelObjectCategory ................................................................................................... 1511
InternalObject ...................................................................................................................... 1512
ContactPressure .......................................................................................................................... 1512
DataModelObjectCategory ................................................................................................... 1515
InternalObject ...................................................................................................................... 1515
ContactSlidingDistance ............................................................................................................... 1515
DataModelObjectCategory ................................................................................................... 1519
InternalObject ...................................................................................................................... 1519
ContactStatus ............................................................................................................................. 1519
DataModelObjectCategory ................................................................................................... 1522
InternalObject ...................................................................................................................... 1523
ContactToolResult ....................................................................................................................... 1523
ContactResultType ................................................................................................................ 1526
DataModelObjectCategory ................................................................................................... 1526
InternalObject ...................................................................................................................... 1526
Ansys.ACT.Automation.Mechanical.Results.BoltToolResults Namespace ..................................... 1527
BoltAdjustment .......................................................................................................................... 1527
BoltResultType ...................................................................................................................... 1530
DataModelObjectCategory ................................................................................................... 1531
InternalObject ...................................................................................................................... 1531
BoltTool ...................................................................................................................................... 1531
Children ............................................................................................................................... 1532
Comments ............................................................................................................................ 1532
DataModelObjectCategory ................................................................................................... 1532
Figures ................................................................................................................................. 1532
Images ................................................................................................................................. 1532
InternalObject ...................................................................................................................... 1532
AddAdjustment() .................................................................................................................. 1533
AddComment() ..................................................................................................................... 1533
AddFigure() .......................................................................................................................... 1533
AddImage(string) .................................................................................................................. 1533

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

AddWorkingLoad() ................................................................................................................ 1533


Delete() ................................................................................................................................ 1533
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1534
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 1534
BoltToolResult ............................................................................................................................ 1534
DataModelObjectCategory ................................................................................................... 1538
InternalObject ...................................................................................................................... 1538
BoltWorkingLoad ........................................................................................................................ 1538
BoltResultType ...................................................................................................................... 1541
DataModelObjectCategory ................................................................................................... 1542
InternalObject ...................................................................................................................... 1542
Ansys.ACT.Automation.Mechanical.Results.BeamToolResults Namespace .................................. 1543
BeamTool ................................................................................................................................... 1543
Children ............................................................................................................................... 1544
Comments ............................................................................................................................ 1544
DataModelObjectCategory ................................................................................................... 1544
Figures ................................................................................................................................. 1544
Images ................................................................................................................................. 1545
InternalObject ...................................................................................................................... 1545
Location ............................................................................................................................... 1545
AddComment() ..................................................................................................................... 1545
AddDirectionalDeformation() ................................................................................................ 1545
AddDirectStress() .................................................................................................................. 1545
AddFigure() .......................................................................................................................... 1546
AddImage(string) .................................................................................................................. 1546
AddMaximumBendingStress() ............................................................................................... 1546
AddMaximumCombinedStress() ............................................................................................ 1546
AddMinimumBendingStress() ............................................................................................... 1546
AddMinimumCombinedStress() ............................................................................................ 1547
AddTotalDeformation() ......................................................................................................... 1547
Delete() ................................................................................................................................ 1547
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1547
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 1547
BeamToolResult .......................................................................................................................... 1548
BeamToolStressResultType .................................................................................................... 1551
DataModelObjectCategory ................................................................................................... 1551
InternalObject ...................................................................................................................... 1551
DirectStress ................................................................................................................................ 1552
DataModelObjectCategory ................................................................................................... 1555
InternalObject ...................................................................................................................... 1555
MaximumBendingStress ............................................................................................................. 1555
DataModelObjectCategory ................................................................................................... 1559
InternalObject ...................................................................................................................... 1559
MaximumCombinedStress .......................................................................................................... 1559
DataModelObjectCategory ................................................................................................... 1562
InternalObject ...................................................................................................................... 1562
MinimumBendingStress .............................................................................................................. 1563
DataModelObjectCategory ................................................................................................... 1566
InternalObject ...................................................................................................................... 1566
MinimumCombinedStress ........................................................................................................... 1566
DataModelObjectCategory ................................................................................................... 1570
InternalObject ...................................................................................................................... 1570

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

Ansys.ACT.Automation.Mechanical.Results.BeamResults Namespace ......................................... 1571


BeamResult ................................................................................................................................ 1571
BeamResultType ................................................................................................................... 1575
DataModelObjectCategory ................................................................................................... 1575
InternalObject ...................................................................................................................... 1575
Surface ................................................................................................................................. 1575
DirectionalAxialForce .................................................................................................................. 1575
DataModelObjectCategory ................................................................................................... 1579
InternalObject ...................................................................................................................... 1579
DirectionalBendingMoment ........................................................................................................ 1579
DataModelObjectCategory ................................................................................................... 1582
InternalObject ...................................................................................................................... 1583
NormalOrientation ................................................................................................................ 1583
DirectionalShearForce ................................................................................................................. 1583
DataModelObjectCategory ................................................................................................... 1586
InternalObject ...................................................................................................................... 1586
DirectionalShearMomentDiagram ............................................................................................... 1587
DataModelObjectCategory ................................................................................................... 1590
GraphicsDisplay .................................................................................................................... 1590
InternalObject ...................................................................................................................... 1590
ShearMomentType ............................................................................................................... 1591
DirectionalTorsionalMoment ....................................................................................................... 1591
DataModelObjectCategory ................................................................................................... 1594
InternalObject ...................................................................................................................... 1594
TotalAxialForce ........................................................................................................................... 1594
DataModelObjectCategory ................................................................................................... 1598
InternalObject ...................................................................................................................... 1598
TotalBendingMoment ................................................................................................................. 1598
DataModelObjectCategory ................................................................................................... 1601
InternalObject ...................................................................................................................... 1602
TotalShearForce .......................................................................................................................... 1602
DataModelObjectCategory ................................................................................................... 1605
InternalObject ...................................................................................................................... 1605
TotalShearMomentDiagram ........................................................................................................ 1606
DataModelObjectCategory ................................................................................................... 1609
GraphicsDisplay .................................................................................................................... 1609
InternalObject ...................................................................................................................... 1609
ShearMomentType ............................................................................................................... 1610
TotalTorsionalMoment ................................................................................................................ 1610
DataModelObjectCategory ................................................................................................... 1613
InternalObject ...................................................................................................................... 1613
VectorAxialForce ......................................................................................................................... 1613
DataModelObjectCategory ................................................................................................... 1617
InternalObject ...................................................................................................................... 1617
VectorBendingMoment ............................................................................................................... 1617
DataModelObjectCategory ................................................................................................... 1620
InternalObject ...................................................................................................................... 1621
VectorShearForce ........................................................................................................................ 1621
DataModelObjectCategory ................................................................................................... 1624
InternalObject ...................................................................................................................... 1624
VectorTorsionalMoment .............................................................................................................. 1624
DataModelObjectCategory ................................................................................................... 1628

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

InternalObject ...................................................................................................................... 1628


Ansys.ACT.Automation.Mechanical.Results.StressResults Namespace ......................................... 1629
BendingStressEquivalent ............................................................................................................ 1630
DataModelObjectCategory ................................................................................................... 1635
InternalObject ...................................................................................................................... 1635
BendingStressIntensity ............................................................................................................... 1635
DataModelObjectCategory ................................................................................................... 1641
InternalObject ...................................................................................................................... 1641
DirectionalStress ......................................................................................................................... 1641
DataModelObjectCategory ................................................................................................... 1647
InternalObject ...................................................................................................................... 1647
EquivalentStress ......................................................................................................................... 1647
DataModelObjectCategory ................................................................................................... 1652
InternalObject ...................................................................................................................... 1653
EquivalentStressPSD ................................................................................................................... 1653
DataModelObjectCategory ................................................................................................... 1658
InternalObject ...................................................................................................................... 1658
ScaleFactorValue ................................................................................................................... 1658
EquivalentStressRS ...................................................................................................................... 1659
DataModelObjectCategory ................................................................................................... 1664
InternalObject ...................................................................................................................... 1664
MaximumPrincipalStress ............................................................................................................. 1664
DataModelObjectCategory ................................................................................................... 1670
InternalObject ...................................................................................................................... 1670
MaximumShearStress ................................................................................................................. 1670
DataModelObjectCategory ................................................................................................... 1676
InternalObject ...................................................................................................................... 1676
ShearOrientation .................................................................................................................. 1676
MembraneStressEquivalent ......................................................................................................... 1676
DataModelObjectCategory ................................................................................................... 1682
InternalObject ...................................................................................................................... 1682
MembraneStressIntensity ........................................................................................................... 1682
DataModelObjectCategory ................................................................................................... 1687
InternalObject ...................................................................................................................... 1688
MiddlePrincipalStress .................................................................................................................. 1688
DataModelObjectCategory ................................................................................................... 1693
InternalObject ...................................................................................................................... 1693
MinimumPrincipalStress ............................................................................................................. 1693
DataModelObjectCategory ................................................................................................... 1699
InternalObject ...................................................................................................................... 1699
NormalStress .............................................................................................................................. 1699
DataModelObjectCategory ................................................................................................... 1705
InternalObject ...................................................................................................................... 1705
ScaleFactorValue ................................................................................................................... 1705
ShearStress ................................................................................................................................. 1705
DataModelObjectCategory ................................................................................................... 1711
InternalObject ...................................................................................................................... 1711
ScaleFactorValue ................................................................................................................... 1711
ShearOrientation .................................................................................................................. 1711
ShellBendingStress ..................................................................................................................... 1711
DataModelObjectCategory ................................................................................................... 1717
InternalObject ...................................................................................................................... 1717

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

NormalOrientation ................................................................................................................ 1717


ScaleFactorValue ................................................................................................................... 1717
ShellMBPType ....................................................................................................................... 1718
ShellBottomPeakStress ............................................................................................................... 1718
DataModelObjectCategory ................................................................................................... 1723
InternalObject ...................................................................................................................... 1723
NormalOrientation ................................................................................................................ 1724
ShellMBPType ....................................................................................................................... 1724
ShellMembraneStress ................................................................................................................. 1724
DataModelObjectCategory ................................................................................................... 1729
InternalObject ...................................................................................................................... 1730
NormalOrientation ................................................................................................................ 1730
ScaleFactorValue ................................................................................................................... 1730
ShellMBPType ....................................................................................................................... 1730
ShellTopPeakStress ..................................................................................................................... 1730
DataModelObjectCategory ................................................................................................... 1736
InternalObject ...................................................................................................................... 1736
NormalOrientation ................................................................................................................ 1736
ShellMBPType ....................................................................................................................... 1736
StressIntensity ............................................................................................................................ 1737
DataModelObjectCategory ................................................................................................... 1742
InternalObject ...................................................................................................................... 1742
StressResult ................................................................................................................................ 1742
Amplitude ............................................................................................................................ 1747
AverageAcrossBodies ............................................................................................................ 1747
AverageRadiusOfCurvature ................................................................................................... 1747
BendingInside ...................................................................................................................... 1747
BendingOutside .................................................................................................................... 1747
CyclicMode ........................................................................................................................... 1747
DataModelObjectCategory ................................................................................................... 1748
Frequency ............................................................................................................................ 1748
HarmonicIndex ..................................................................................................................... 1748
InternalObject ...................................................................................................................... 1748
Layer .................................................................................................................................... 1748
Linearized2DBehavior ........................................................................................................... 1748
LoadMultiplier ...................................................................................................................... 1749
Membrane ............................................................................................................................ 1749
MembraneBendingCenter ..................................................................................................... 1749
MembraneBendingInside ...................................................................................................... 1749
MembraneBendingOutside ................................................................................................... 1749
Mode .................................................................................................................................... 1749
NormalOrientation ................................................................................................................ 1750
PeakCenter ........................................................................................................................... 1750
PeakInside ............................................................................................................................ 1750
PeakOutside ......................................................................................................................... 1750
PhaseIncrement .................................................................................................................... 1750
Ply ........................................................................................................................................ 1750
Position ................................................................................................................................ 1751
Probability ............................................................................................................................ 1751
ReportedFrequency .............................................................................................................. 1751
ScaleFactor ........................................................................................................................... 1751
StressStrainType ................................................................................................................... 1751

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

SubScopeBy ......................................................................................................................... 1751


Subtype ................................................................................................................................ 1752
Surface ................................................................................................................................. 1752
SweepingPhase .................................................................................................................... 1752
ThroughThicknessBendingStress ........................................................................................... 1752
TotalCenter ........................................................................................................................... 1752
TotalInside ............................................................................................................................ 1752
TotalOutside ......................................................................................................................... 1753
StructuralError ............................................................................................................................ 1753
DataModelObjectCategory ................................................................................................... 1758
InternalObject ...................................................................................................................... 1758
VectorPrincipalStress .................................................................................................................. 1759
DataModelObjectCategory ................................................................................................... 1764
InternalObject ...................................................................................................................... 1764
Ansys.ACT.Automation.Mechanical.Results.ResultTrackers Namespace ....................................... 1765
CampbellDiagram ....................................................................................................................... 1767
CriticalSpeed ........................................................................................................................ 1770
DataModelObjectCategory ................................................................................................... 1770
InternalObject ...................................................................................................................... 1770
Ratio ..................................................................................................................................... 1770
RotationalVelocitySelection .................................................................................................. 1771
Sorting ................................................................................................................................. 1771
XAxisLabel ............................................................................................................................ 1771
XAxisMaximum ..................................................................................................................... 1771
XAxisMinimum ..................................................................................................................... 1771
XAxisRange .......................................................................................................................... 1771
YAxisData ............................................................................................................................. 1772
YAxisLabel ............................................................................................................................ 1772
YAxisMaximum ..................................................................................................................... 1772
YAxisMinimum ...................................................................................................................... 1772
YAxisRange ........................................................................................................................... 1772
ContactChatteringTracker ........................................................................................................... 1772
ContactRegion ...................................................................................................................... 1775
ContactSide .......................................................................................................................... 1775
DataModelObjectCategory ................................................................................................... 1776
InternalObject ...................................................................................................................... 1776
ContactClosedPenetrationTracker ............................................................................................... 1776
ContactRegion ...................................................................................................................... 1779
DataModelObjectCategory ................................................................................................... 1779
InternalObject ...................................................................................................................... 1779
ContactDepthTracker .................................................................................................................. 1779
ContactRegion ...................................................................................................................... 1782
DataModelObjectCategory ................................................................................................... 1782
InternalObject ...................................................................................................................... 1782
ContactElasticSlipTracker ............................................................................................................ 1783
ContactRegion ...................................................................................................................... 1785
ContactSide .......................................................................................................................... 1786
DataModelObjectCategory ................................................................................................... 1786
InternalObject ...................................................................................................................... 1786
ContactEnergyTracker ................................................................................................................. 1786
ContactRegion ...................................................................................................................... 1789
DataModelObjectCategory ................................................................................................... 1789

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

InternalObject ...................................................................................................................... 1789


ContactFluidPressureTracker ....................................................................................................... 1789
ContactRegion ...................................................................................................................... 1792
ContactSide .......................................................................................................................... 1792
DataModelObjectCategory ................................................................................................... 1793
InternalObject ...................................................................................................................... 1793
ContactForceTracker ................................................................................................................... 1793
ContactSide .......................................................................................................................... 1796
DataModelObjectCategory ................................................................................................... 1796
InternalObject ...................................................................................................................... 1796
ContactFrictionalDissipationEnergyTracker .................................................................................. 1796
ContactRegion ...................................................................................................................... 1799
DataModelObjectCategory ................................................................................................... 1799
InternalObject ...................................................................................................................... 1799
ContactFrictionalStressTracker .................................................................................................... 1800
ContactRegion ...................................................................................................................... 1802
ContactSide .......................................................................................................................... 1803
DataModelObjectCategory ................................................................................................... 1803
InternalObject ...................................................................................................................... 1803
ContactGapTracker ..................................................................................................................... 1803
ContactRegion ...................................................................................................................... 1806
ContactSide .......................................................................................................................... 1806
DataModelObjectCategory ................................................................................................... 1806
InternalObject ...................................................................................................................... 1806
ContactHeatFluxTracker .............................................................................................................. 1807
ContactRegion ...................................................................................................................... 1809
DataModelObjectCategory ................................................................................................... 1809
InternalObject ...................................................................................................................... 1810
ContactingAreaTracker ............................................................................................................... 1810
ContactRegion ...................................................................................................................... 1813
ContactSide .......................................................................................................................... 1813
DataModelObjectCategory ................................................................................................... 1813
InternalObject ...................................................................................................................... 1813
ContactMaximumDampingPressureTracker ................................................................................. 1813
ContactRegion ...................................................................................................................... 1816
ContactSide .......................................................................................................................... 1816
DataModelObjectCategory ................................................................................................... 1816
InternalObject ...................................................................................................................... 1817
ContactMaximumGeometricSlidingDistanceTracker .................................................................... 1817
ContactRegion ...................................................................................................................... 1820
ContactSide .......................................................................................................................... 1820
DataModelObjectCategory ................................................................................................... 1820
InternalObject ...................................................................................................................... 1820
ContactMaximumNormalStiffnessTracker .................................................................................... 1820
ContactRegion ...................................................................................................................... 1823
ContactSide .......................................................................................................................... 1823
DataModelObjectCategory ................................................................................................... 1823
InternalObject ...................................................................................................................... 1824
ContactMaximumTangentialStiffnessTracker ............................................................................... 1824
ContactRegion ...................................................................................................................... 1827
ContactSide .......................................................................................................................... 1827
DataModelObjectCategory ................................................................................................... 1827

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

InternalObject ...................................................................................................................... 1827


ContactMinimumGeometricSlidingDistanceTracker ..................................................................... 1827
ContactRegion ...................................................................................................................... 1830
ContactSide .......................................................................................................................... 1830
DataModelObjectCategory ................................................................................................... 1830
InternalObject ...................................................................................................................... 1831
ContactMinimumNormalStiffnessTracker .................................................................................... 1831
ContactRegion ...................................................................................................................... 1834
DataModelObjectCategory ................................................................................................... 1834
InternalObject ...................................................................................................................... 1834
ContactMinimumTangentialStiffnessTracker ................................................................................ 1834
ContactRegion ...................................................................................................................... 1837
ContactSide .......................................................................................................................... 1837
DataModelObjectCategory ................................................................................................... 1837
InternalObject ...................................................................................................................... 1837
ContactNumberStickingTracker ................................................................................................... 1838
ContactRegion ...................................................................................................................... 1840
ContactSide .......................................................................................................................... 1841
DataModelObjectCategory ................................................................................................... 1841
InternalObject ...................................................................................................................... 1841
ContactNumberWithLargePenetrationTracker ............................................................................. 1841
ContactRegion ...................................................................................................................... 1844
DataModelObjectCategory ................................................................................................... 1844
InternalObject ...................................................................................................................... 1844
ContactNumberWithTooMuchSlidingTracker ............................................................................... 1844
ContactRegion ...................................................................................................................... 1847
DataModelObjectCategory ................................................................................................... 1847
InternalObject ...................................................................................................................... 1848
ContactPenetrationTracker .......................................................................................................... 1848
ContactRegion ...................................................................................................................... 1851
ContactSide .......................................................................................................................... 1851
DataModelObjectCategory ................................................................................................... 1851
InternalObject ...................................................................................................................... 1851
ContactPressureTracker ............................................................................................................... 1851
ContactRegion ...................................................................................................................... 1854
ContactSide .......................................................................................................................... 1854
DataModelObjectCategory ................................................................................................... 1854
InternalObject ...................................................................................................................... 1855
ContactResultingPinballTracker ................................................................................................... 1855
ContactRegion ...................................................................................................................... 1858
ContactSide .......................................................................................................................... 1858
DataModelObjectCategory ................................................................................................... 1858
InternalObject ...................................................................................................................... 1858
ContactSlidingDistanceTracker .................................................................................................... 1858
ContactRegion ...................................................................................................................... 1861
ContactSide .......................................................................................................................... 1861
DataModelObjectCategory ................................................................................................... 1861
InternalObject ...................................................................................................................... 1862
ContactSlidingIndicationTracker .................................................................................................. 1862
ContactRegion ...................................................................................................................... 1865
DataModelObjectCategory ................................................................................................... 1865
InternalObject ...................................................................................................................... 1865

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

ContactStabilizationEnergyTracker .............................................................................................. 1865


ContactRegion ...................................................................................................................... 1868
DataModelObjectCategory ................................................................................................... 1868
InternalObject ...................................................................................................................... 1868
ContactStrainEnergyTracker ........................................................................................................ 1868
ContactRegion ...................................................................................................................... 1871
DataModelObjectCategory ................................................................................................... 1871
InternalObject ...................................................................................................................... 1872
ContactTangentialDampingStressTracker .................................................................................... 1872
ContactRegion ...................................................................................................................... 1875
DataModelObjectCategory ................................................................................................... 1875
InternalObject ...................................................................................................................... 1875
ContactTotalForceFromContactPressureXTracker ......................................................................... 1875
ContactRegion ...................................................................................................................... 1878
DataModelObjectCategory ................................................................................................... 1878
InternalObject ...................................................................................................................... 1878
ContactTotalForceFromContactPressureYTracker ......................................................................... 1878
ContactRegion ...................................................................................................................... 1881
DataModelObjectCategory ................................................................................................... 1881
InternalObject ...................................................................................................................... 1882
ContactTotalForceFromContactPressureZTracker ......................................................................... 1882
ContactRegion ...................................................................................................................... 1885
DataModelObjectCategory ................................................................................................... 1885
InternalObject ...................................................................................................................... 1885
ContactTotalForceFromTangentialStressXTracker ......................................................................... 1885
ContactRegion ...................................................................................................................... 1888
DataModelObjectCategory ................................................................................................... 1888
InternalObject ...................................................................................................................... 1888
ContactTotalForceFromTangentialStressYTracker ......................................................................... 1888
ContactRegion ...................................................................................................................... 1891
DataModelObjectCategory ................................................................................................... 1891
InternalObject ...................................................................................................................... 1892
ContactTotalForceFromTangentialStressZTracker ......................................................................... 1892
ContactRegion ...................................................................................................................... 1895
DataModelObjectCategory ................................................................................................... 1895
InternalObject ...................................................................................................................... 1895
ContactVolumeLossDueToWearTracker ....................................................................................... 1895
ContactRegion ...................................................................................................................... 1898
DataModelObjectCategory ................................................................................................... 1898
InternalObject ...................................................................................................................... 1898
DensityTracker ............................................................................................................................ 1898
DataModelObjectCategory ................................................................................................... 1901
InternalObject ...................................................................................................................... 1902
LocationCoordinateSystem ................................................................................................... 1902
LocationMethod ................................................................................................................... 1902
LocationXCoordinate ............................................................................................................ 1902
LocationYCoordinate ............................................................................................................ 1902
LocationZCoordinate ............................................................................................................ 1902
DirectionalAccelerationTracker .................................................................................................... 1903
DataModelObjectCategory ................................................................................................... 1905
InternalObject ...................................................................................................................... 1906
LocationCoordinateSystem ................................................................................................... 1906

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

LocationMethod ................................................................................................................... 1906


LocationXCoordinate ............................................................................................................ 1906
LocationYCoordinate ............................................................................................................ 1906
LocationZCoordinate ............................................................................................................ 1906
DirectionalDeformationTracker ................................................................................................... 1907
DataModelObjectCategory ................................................................................................... 1910
InternalObject ...................................................................................................................... 1910
LocationCoordinateSystem ................................................................................................... 1910
LocationMethod ................................................................................................................... 1910
LocationXCoordinate ............................................................................................................ 1910
LocationYCoordinate ............................................................................................................ 1910
LocationZCoordinate ............................................................................................................ 1911
DirectionalVelocityTracker ........................................................................................................... 1911
DataModelObjectCategory ................................................................................................... 1914
InternalObject ...................................................................................................................... 1914
LocationCoordinateSystem ................................................................................................... 1914
LocationMethod ................................................................................................................... 1914
LocationXCoordinate ............................................................................................................ 1914
LocationYCoordinate ............................................................................................................ 1914
LocationZCoordinate ............................................................................................................ 1915
EffectiveStrainTracker ................................................................................................................. 1915
DataModelObjectCategory ................................................................................................... 1918
InternalObject ...................................................................................................................... 1918
LocationCoordinateSystem ................................................................................................... 1918
LocationMethod ................................................................................................................... 1918
LocationXCoordinate ............................................................................................................ 1918
LocationYCoordinate ............................................................................................................ 1919
LocationZCoordinate ............................................................................................................ 1919
EffectiveStressTracker ................................................................................................................. 1919
DataModelObjectCategory ................................................................................................... 1922
InternalObject ...................................................................................................................... 1922
LocationCoordinateSystem ................................................................................................... 1922
LocationMethod ................................................................................................................... 1922
LocationXCoordinate ............................................................................................................ 1922
LocationYCoordinate ............................................................................................................ 1923
LocationZCoordinate ............................................................................................................ 1923
ExternalForceTracker ................................................................................................................... 1923
DataModelObjectCategory ................................................................................................... 1926
InternalObject ...................................................................................................................... 1926
ForceReactionTracker .................................................................................................................. 1926
DataModelObjectCategory ................................................................................................... 1929
InternalObject ...................................................................................................................... 1929
HourglassEnergyTracker .............................................................................................................. 1929
ContactRegion ...................................................................................................................... 1932
DataModelObjectCategory ................................................................................................... 1932
InternalObject ...................................................................................................................... 1932
InternalEnergyTracker ................................................................................................................. 1932
DataModelObjectCategory ................................................................................................... 1935
InternalObject ...................................................................................................................... 1936
LocationCoordinateSystem ................................................................................................... 1936
LocationMethod ................................................................................................................... 1936
LocationXCoordinate ............................................................................................................ 1936

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

LocationYCoordinate ............................................................................................................ 1936


LocationZCoordinate ............................................................................................................ 1936
KineticEnergyTracker .................................................................................................................. 1937
DataModelObjectCategory ................................................................................................... 1939
InternalObject ...................................................................................................................... 1939
MomentReactionTracker ............................................................................................................. 1940
DataModelObjectCategory ................................................................................................... 1942
InternalObject ...................................................................................................................... 1943
MomentumTracker ..................................................................................................................... 1943
DataModelObjectCategory ................................................................................................... 1945
InternalObject ...................................................................................................................... 1946
NumberContactingTracker .......................................................................................................... 1946
ContactRegion ...................................................................................................................... 1949
ContactSide .......................................................................................................................... 1949
DataModelObjectCategory ................................................................................................... 1949
InternalObject ...................................................................................................................... 1949
PlasticWorkTracker ...................................................................................................................... 1949
DataModelObjectCategory ................................................................................................... 1952
InternalObject ...................................................................................................................... 1952
PositionTracker ........................................................................................................................... 1952
DataModelObjectCategory ................................................................................................... 1955
InternalObject ...................................................................................................................... 1956
LocationCoordinateSystem ................................................................................................... 1956
LocationMethod ................................................................................................................... 1956
LocationXCoordinate ............................................................................................................ 1956
LocationYCoordinate ............................................................................................................ 1956
LocationZCoordinate ............................................................................................................ 1956
PressureTracker ........................................................................................................................... 1957
DataModelObjectCategory ................................................................................................... 1959
InternalObject ...................................................................................................................... 1960
LocationCoordinateSystem ................................................................................................... 1960
LocationMethod ................................................................................................................... 1960
LocationXCoordinate ............................................................................................................ 1960
LocationYCoordinate ............................................................................................................ 1960
LocationZCoordinate ............................................................................................................ 1960
SpringDampingForceTracker ....................................................................................................... 1961
DataModelObjectCategory ................................................................................................... 1963
InternalObject ...................................................................................................................... 1964
SpringElasticForceTracker ........................................................................................................... 1964
DataModelObjectCategory ................................................................................................... 1966
InternalObject ...................................................................................................................... 1967
SpringElongationTracker ............................................................................................................. 1967
DataModelObjectCategory ................................................................................................... 1970
InternalObject ...................................................................................................................... 1970
SpringVelocityTracker ................................................................................................................. 1970
DataModelObjectCategory ................................................................................................... 1973
InternalObject ...................................................................................................................... 1973
StiffnessEnergyTracker ................................................................................................................ 1973
DataModelObjectCategory ................................................................................................... 1976
InternalObject ...................................................................................................................... 1976
TemperatureTracker .................................................................................................................... 1976
DataModelObjectCategory ................................................................................................... 1979

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

InternalObject ...................................................................................................................... 1979


LocationCoordinateSystem ................................................................................................... 1979
LocationMethod ................................................................................................................... 1980
LocationXCoordinate ............................................................................................................ 1980
LocationYCoordinate ............................................................................................................ 1980
LocationZCoordinate ............................................................................................................ 1980
TotalEnergyTracker ..................................................................................................................... 1980
DataModelObjectCategory ................................................................................................... 1983
InternalObject ...................................................................................................................... 1983
TotalMassAverageVelocityTracker ................................................................................................ 1983
DataModelObjectCategory ................................................................................................... 1986
InternalObject ...................................................................................................................... 1986
Ansys.ACT.Automation.Mechanical.Results.ProbeResults Namespace ......................................... 1987
AccelerationProbe ...................................................................................................................... 1988
DataModelObjectCategory ................................................................................................... 1991
InternalObject ...................................................................................................................... 1991
AngularAccelerationProbe .......................................................................................................... 1991
DataModelObjectCategory ................................................................................................... 1994
InternalObject ...................................................................................................................... 1994
AngularVelocityProbe ................................................................................................................. 1994
DataModelObjectCategory ................................................................................................... 1997
InternalObject ...................................................................................................................... 1997
BeamProbe ................................................................................................................................. 1997
AxialForce ............................................................................................................................. 2000
DataModelObjectCategory ................................................................................................... 2000
InternalObject ...................................................................................................................... 2000
MaximumAxialForce ............................................................................................................. 2001
MaximumMomentAtI ............................................................................................................ 2001
MaximumMomentAtJ ........................................................................................................... 2001
MaximumShearForceAtI ........................................................................................................ 2001
MaximumShearForceAtJ ....................................................................................................... 2001
MaximumTorque .................................................................................................................. 2001
MinimumAxialForce .............................................................................................................. 2002
MinimumMomentAtI ............................................................................................................ 2002
MinimumMomentAtJ ............................................................................................................ 2002
MinimumShearForceAtI ........................................................................................................ 2002
MinimumShearForceAtJ ........................................................................................................ 2002
MinimumTorque ................................................................................................................... 2002
MomentAtI ........................................................................................................................... 2003
MomentAtJ ........................................................................................................................... 2003
ShearForceAtI ....................................................................................................................... 2003
ShearForceAtJ ....................................................................................................................... 2003
Torque .................................................................................................................................. 2003
BearingProbe .............................................................................................................................. 2003
By ......................................................................................................................................... 2007
DampingForce1 .................................................................................................................... 2007
DampingForce2 .................................................................................................................... 2007
DataModelObjectCategory ................................................................................................... 2007
ElasticForce1 ......................................................................................................................... 2008
ElasticForce2 ......................................................................................................................... 2008
Elongation1 .......................................................................................................................... 2008
Elongation2 .......................................................................................................................... 2008

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

InternalObject ...................................................................................................................... 2008


MaximumDampingForce1 .................................................................................................... 2008
MaximumDampingForce2 .................................................................................................... 2009
MaximumElasticForce1 ......................................................................................................... 2009
MaximumElasticForce2 ......................................................................................................... 2009
MaximumElongation1 .......................................................................................................... 2009
MaximumElongation2 .......................................................................................................... 2009
MaximumVelocity1 ............................................................................................................... 2009
MaximumVelocity2 ............................................................................................................... 2010
MinimumDampingForce1 ..................................................................................................... 2010
MinimumDampingForce2 ..................................................................................................... 2010
MinimumElasticForce1 .......................................................................................................... 2010
MinimumElasticForce2 .......................................................................................................... 2010
MinimumElongation1 ........................................................................................................... 2010
MinimumElongation2 ........................................................................................................... 2011
MinimumVelocity1 ................................................................................................................ 2011
MinimumVelocity2 ................................................................................................................ 2011
PhaseIncrement .................................................................................................................... 2011
ReportedFrequency .............................................................................................................. 2011
ScaleFactor ........................................................................................................................... 2011
ScaleFactorValue ................................................................................................................... 2012
SweepingPhase .................................................................................................................... 2012
Velocity1 .............................................................................................................................. 2012
Velocity2 .............................................................................................................................. 2012
BoltPretensionProbe ................................................................................................................... 2012
Adjustment .......................................................................................................................... 2015
DataModelObjectCategory ................................................................................................... 2015
InternalObject ...................................................................................................................... 2015
MaximumAdjustment ........................................................................................................... 2016
MaximumWorkingLoad ......................................................................................................... 2016
MinimumAdjustment ............................................................................................................ 2016
MinimumWorkingLoad ......................................................................................................... 2016
ScaleFactor ........................................................................................................................... 2016
ScaleFactorValue ................................................................................................................... 2016
WorkingLoad ........................................................................................................................ 2017
CurrentDensityProbe .................................................................................................................. 2017
CurrentDensityTotal .............................................................................................................. 2020
DataModelObjectCategory ................................................................................................... 2020
InternalObject ...................................................................................................................... 2020
XAxisCurrentDensity ............................................................................................................. 2020
YAxisCurrentDensity ............................................................................................................. 2020
ZAxisCurrentDensity ............................................................................................................. 2020
DeformationProbe ...................................................................................................................... 2021
DataModelObjectCategory ................................................................................................... 2024
InternalObject ...................................................................................................................... 2024
MaximumTotalDeformation .................................................................................................. 2024
MaximumXAxisDeformation ................................................................................................. 2024
MaximumYAxisDeformation .................................................................................................. 2024
MaximumZAxisDeformation ................................................................................................. 2024
MinimumTotalDeformation ................................................................................................... 2025
MinimumXAxisDeformation .................................................................................................. 2025
MinimumYAxisDeformation .................................................................................................. 2025

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

MinimumZAxisDeformation .................................................................................................. 2025


TotalDeformation ................................................................................................................. 2025
XAxisDeformation ................................................................................................................. 2025
XCoordinate ......................................................................................................................... 2026
YAxisDeformation ................................................................................................................. 2026
YCoordinate .......................................................................................................................... 2026
ZAxisDeformation ................................................................................................................. 2026
ZCoordinate ......................................................................................................................... 2026
ElectricFieldProbe ....................................................................................................................... 2026
DataModelObjectCategory ................................................................................................... 2029
InternalObject ...................................................................................................................... 2029
Total ..................................................................................................................................... 2029
YAxisFieldIntensity ................................................................................................................ 2030
ZAxisFieldIntensity ................................................................................................................ 2030
ElectricVoltageProbe ................................................................................................................... 2030
DataModelObjectCategory ................................................................................................... 2033
InternalObject ...................................................................................................................... 2033
MaximumVoltageProbe ........................................................................................................ 2033
MinimumVoltageProbe ......................................................................................................... 2033
VoltageProbe ........................................................................................................................ 2033
EmagReactionProbe ................................................................................................................... 2034
Current ................................................................................................................................. 2036
DataModelObjectCategory ................................................................................................... 2036
InternalObject ...................................................................................................................... 2037
MaximumCurrent ................................................................................................................. 2037
MinimumCurrent .................................................................................................................. 2037
EnergyProbe ............................................................................................................................... 2037
ContactEnergy ...................................................................................................................... 2041
DataModelObjectCategory ................................................................................................... 2041
ExternalEnergy ..................................................................................................................... 2041
HourglassEnergy ................................................................................................................... 2041
InternalEnergy ...................................................................................................................... 2041
InternalObject ...................................................................................................................... 2041
KineticEnergy ....................................................................................................................... 2042
MagnetostaticCoEnergy ........................................................................................................ 2042
MaximumContactEnergy ...................................................................................................... 2042
MaximumExternalEnergy ...................................................................................................... 2042
MaximumHourglassEnergy ................................................................................................... 2042
MaximumInternalEnergy ....................................................................................................... 2042
MaximumKineticEnergy ........................................................................................................ 2043
MaximumPlasticWork ........................................................................................................... 2043
MaximumPotentialEnergy ..................................................................................................... 2043
MaximumStrainEnergy .......................................................................................................... 2043
MaximumTotalEnergy ........................................................................................................... 2043
MaxMagnetostaticCoEnergyOverTime .................................................................................. 2043
MinimumContactEnergy ....................................................................................................... 2044
MinimumExternalEnergy ...................................................................................................... 2044
MinimumHourglassEnergy .................................................................................................... 2044
MinimumInternalEnergy ....................................................................................................... 2044
MinimumKineticEnergy ........................................................................................................ 2044
MinimumPlasticWork ............................................................................................................ 2044
MinimumPotentialEnergy ..................................................................................................... 2045

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

MinimumStrainEnergy .......................................................................................................... 2045


MinimumTotalEnergy ........................................................................................................... 2045
MinMagnetostaticCoEnergyOverTime ................................................................................... 2045
PlasticWork ........................................................................................................................... 2045
PotentialEnergy .................................................................................................................... 2045
StrainEnergy ......................................................................................................................... 2046
TotalEnergy .......................................................................................................................... 2046
FieldIntensityProbe ..................................................................................................................... 2046
DataModelObjectCategory ................................................................................................... 2049
InternalObject ...................................................................................................................... 2049
TotalFieldIntensity ................................................................................................................ 2049
YAxisFieldIntensity ................................................................................................................ 2049
FluxDensityProbe ....................................................................................................................... 2049
DataModelObjectCategory ................................................................................................... 2052
InternalObject ...................................................................................................................... 2053
Probability ............................................................................................................................ 2053
TotalFluxDensity ................................................................................................................... 2053
XAxisFluxDensity .................................................................................................................. 2053
XCoordinate ......................................................................................................................... 2053
YAxisFluxDensity ................................................................................................................... 2053
YCoordinate .......................................................................................................................... 2054
ZAxisFluxDensity .................................................................................................................. 2054
ZCoordinate ......................................................................................................................... 2054
ForceReaction ............................................................................................................................. 2054
Beam .................................................................................................................................... 2057
By ......................................................................................................................................... 2057
ContactForce ........................................................................................................................ 2057
DataModelObjectCategory ................................................................................................... 2058
Extraction ............................................................................................................................. 2058
InternalObject ...................................................................................................................... 2058
Mode .................................................................................................................................... 2058
PhaseIncrement .................................................................................................................... 2058
Probability ............................................................................................................................ 2058
Reference ............................................................................................................................. 2059
RemotePoints ....................................................................................................................... 2059
ReportedFrequency .............................................................................................................. 2059
ScaleFactor ........................................................................................................................... 2059
ScaleFactorValue ................................................................................................................... 2059
Spring .................................................................................................................................. 2059
SurfaceArea .......................................................................................................................... 2060
SweepingPhase .................................................................................................................... 2060
SymmetryMultiplier .............................................................................................................. 2060
ForceSummationProbe ............................................................................................................... 2060
DataModelObjectCategory ................................................................................................... 2063
InternalObject ...................................................................................................................... 2063
GeneralizedPlaneStrainProbe ...................................................................................................... 2063
DataModelObjectCategory ................................................................................................... 2066
InternalObject ...................................................................................................................... 2066
HeatFluxProbe ............................................................................................................................ 2066
DataModelObjectCategory ................................................................................................... 2069
InternalObject ...................................................................................................................... 2069
MaximumTotalHeatFlux ........................................................................................................ 2070

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

MaximumXAxisHeatFlux ....................................................................................................... 2070


MaximumYAxisHeatFlux ........................................................................................................ 2070
MaximumZAxisHeatFlux ....................................................................................................... 2070
MinimumTotalHeatFlux ......................................................................................................... 2070
MinimumXAxisHeatFlux ........................................................................................................ 2070
MinimumYAxisHeatFlux ........................................................................................................ 2071
MinimumZAxisHeatFlux ........................................................................................................ 2071
TotalHeatFlux ....................................................................................................................... 2071
XAxisHeatFlux ....................................................................................................................... 2071
XCoordinate ......................................................................................................................... 2071
YAxisHeatFlux ....................................................................................................................... 2071
YCoordinate .......................................................................................................................... 2072
ZAxisHeatFlux ....................................................................................................................... 2072
ZCoordinate ......................................................................................................................... 2072
JointProbe .................................................................................................................................. 2072
DataModelObjectCategory ................................................................................................... 2075
InternalObject ...................................................................................................................... 2075
OrientationMethod ............................................................................................................... 2075
ResultType ............................................................................................................................ 2075
JouleHeatProbe .......................................................................................................................... 2075
DataModelObjectCategory ................................................................................................... 2078
InternalObject ...................................................................................................................... 2078
JouleHeat ............................................................................................................................. 2079
MaximumJouleHeat .............................................................................................................. 2079
MinimumJouleHeat .............................................................................................................. 2079
MagneticFluxProbe ..................................................................................................................... 2079
DataModelObjectCategory ................................................................................................... 2082
InternalObject ...................................................................................................................... 2082
MagneticFlux ........................................................................................................................ 2082
MaximumMagneticFlux ........................................................................................................ 2082
MinimumMagneticFlux ......................................................................................................... 2082
SymmetryMultiplier .............................................................................................................. 2083
MomentReaction ........................................................................................................................ 2083
Beam .................................................................................................................................... 2086
By ......................................................................................................................................... 2086
ContactForce ........................................................................................................................ 2086
DataModelObjectCategory ................................................................................................... 2086
Extraction ............................................................................................................................. 2087
InternalObject ...................................................................................................................... 2087
Mode .................................................................................................................................... 2087
PhaseIncrement .................................................................................................................... 2087
Probability ............................................................................................................................ 2087
Reference ............................................................................................................................. 2087
RemotePoints ....................................................................................................................... 2088
ReportedFrequency .............................................................................................................. 2088
ScaleFactor ........................................................................................................................... 2088
ScaleFactorValue ................................................................................................................... 2088
SurfaceArea .......................................................................................................................... 2088
SweepingPhase .................................................................................................................... 2088
SymmetryMultiplier .............................................................................................................. 2089
Position ...................................................................................................................................... 2089
DataModelObjectCategory ................................................................................................... 2091

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

InternalObject ...................................................................................................................... 2092


RadiationProbe ........................................................................................................................... 2092
DataModelObjectCategory ................................................................................................... 2095
EmittedRadiation .................................................................................................................. 2095
IncidentRadiation ................................................................................................................. 2095
InternalObject ...................................................................................................................... 2095
NetRadiation ........................................................................................................................ 2095
ReflectedRadiation ............................................................................................................... 2095
ReactionProbe ............................................................................................................................ 2096
DataModelObjectCategory ................................................................................................... 2098
Heat ..................................................................................................................................... 2098
InternalObject ...................................................................................................................... 2099
MaximumHeat ...................................................................................................................... 2099
MinimumHeat ...................................................................................................................... 2099
ResponsePSD .............................................................................................................................. 2099
AccelerationInG .................................................................................................................... 2102
DataModelObjectCategory ................................................................................................... 2102
ExpectedFrequency .............................................................................................................. 2102
InternalObject ...................................................................................................................... 2103
Probability ............................................................................................................................ 2103
RangeMaximum ................................................................................................................... 2103
RangeMinimum .................................................................................................................... 2103
Reference ............................................................................................................................. 2103
ResultType ............................................................................................................................ 2103
RMSPercentage .................................................................................................................... 2104
RMSValue ............................................................................................................................. 2104
SelectedFrequencyRange ..................................................................................................... 2104
ResultProbe ................................................................................................................................ 2104
BeamSelection ...................................................................................................................... 2106
BoundaryConditionSelection ................................................................................................ 2106
Children ............................................................................................................................... 2106
Comments ............................................................................................................................ 2106
ContactRegionSelection ....................................................................................................... 2106
CoordinateSystemSelection .................................................................................................. 2107
DataModelObjectCategory ................................................................................................... 2107
DisplayTime .......................................................................................................................... 2107
Figures ................................................................................................................................. 2107
GeometryLocation ................................................................................................................ 2107
Images ................................................................................................................................. 2107
InternalObject ...................................................................................................................... 2108
IsSolved ................................................................................................................................ 2108
IterationNumber ................................................................................................................... 2108
LoadStep .............................................................................................................................. 2108
LocationMethod ................................................................................................................... 2108
MaximumTotal ...................................................................................................................... 2108
MaximumXAxis ..................................................................................................................... 2109
MaximumYAxis ..................................................................................................................... 2109
MaximumZAxis ..................................................................................................................... 2109
MeshConnectionSelection .................................................................................................... 2109
MinimumTotal ...................................................................................................................... 2109
MinimumXAxis ..................................................................................................................... 2109
MinimumYAxis ...................................................................................................................... 2110

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

MinimumZAxis ..................................................................................................................... 2110


Orientation ........................................................................................................................... 2110
RemotePointSelection .......................................................................................................... 2110
ResultSelection ..................................................................................................................... 2110
RpmSetNumber .................................................................................................................... 2110
SpatialResolution .................................................................................................................. 2111
SpringSelection .................................................................................................................... 2111
Substep ................................................................................................................................ 2111
Summation ........................................................................................................................... 2111
Suppressed ........................................................................................................................... 2111
SurfaceSelection ................................................................................................................... 2111
Time ..................................................................................................................................... 2112
Total ..................................................................................................................................... 2112
Type ..................................................................................................................................... 2112
XAxis .................................................................................................................................... 2112
YAxis ..................................................................................................................................... 2112
ZAxis .................................................................................................................................... 2112
AddComment() ..................................................................................................................... 2113
AddFigure() .......................................................................................................................... 2113
AddImage(string) .................................................................................................................. 2113
ClearGeneratedData() ........................................................................................................... 2113
Delete() ................................................................................................................................ 2113
EvaluateAllResults() ............................................................................................................... 2113
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2114
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2114
RotationProbe ............................................................................................................................ 2114
DataModelObjectCategory ................................................................................................... 2117
InternalObject ...................................................................................................................... 2118
MaximumXAxisRotation ........................................................................................................ 2118
MaximumYAxisRotation ........................................................................................................ 2118
MaximumZAxisRotation ........................................................................................................ 2118
MinimumXAxisRotation ........................................................................................................ 2118
MinimumYAxisRotation ......................................................................................................... 2118
MinimumZAxisRotation ........................................................................................................ 2119
XAxisRotation ....................................................................................................................... 2119
YAxisRotation ....................................................................................................................... 2119
ZAxisRotation ....................................................................................................................... 2119
SpringProbe ............................................................................................................................... 2119
DampingForce ...................................................................................................................... 2122
DataModelObjectCategory ................................................................................................... 2122
ElasticForce .......................................................................................................................... 2123
Elongation ............................................................................................................................ 2123
InternalObject ...................................................................................................................... 2123
MaximumDampingForce ...................................................................................................... 2123
MaximumElasticForce ........................................................................................................... 2123
MaximumElongation ............................................................................................................ 2123
MaximumVelocity ................................................................................................................. 2124
MinimumDampingForce ....................................................................................................... 2124
MinimumElasticForce ............................................................................................................ 2124
MinimumElongation ............................................................................................................. 2124
MinimumVelocity ................................................................................................................. 2124
ScaleFactor ........................................................................................................................... 2124

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

ScaleFactorValue ................................................................................................................... 2125


Spring .................................................................................................................................. 2125
Velocity ................................................................................................................................ 2125
StrainProbe ................................................................................................................................. 2125
DataModelObjectCategory ................................................................................................... 2129
EquivalentStrain ................................................................................................................... 2129
InternalObject ...................................................................................................................... 2129
MaximumEquivalentStrain .................................................................................................... 2129
MaximumMaximumPrincipalStrain ........................................................................................ 2129
MaximumMiddlePrincipalStrain ............................................................................................ 2130
MaximumMinimumPrincipalStrain ........................................................................................ 2130
MaximumNormalXAxisStrain ................................................................................................ 2130
MaximumNormalYAxisStrain ................................................................................................. 2130
MaximumNormalZAxisStrain ................................................................................................. 2130
MaximumPrincipalStrain ....................................................................................................... 2130
MaximumStrainIntensity ....................................................................................................... 2131
MaximumXYShearStrain ....................................................................................................... 2131
MaximumXZShearStrain ....................................................................................................... 2131
MaximumYZShearStrain ........................................................................................................ 2131
MiddlePrincipalStrain ............................................................................................................ 2131
MinimumEquivalentStrain ..................................................................................................... 2131
MinimumMiddlePrincipalStrain ............................................................................................. 2132
MinimumMinimumPrincipalStrain ......................................................................................... 2132
MinimumNormalXAxisStrain ................................................................................................. 2132
MinimumNormalYAxisStrain ................................................................................................. 2132
MinimumNormalZAxisStrain ................................................................................................. 2132
MinimumPrincipalStrain ....................................................................................................... 2132
MinimumStrain ..................................................................................................................... 2133
MinimumStrainIntensity ....................................................................................................... 2133
MinimumStrainMaximumPrincipal ........................................................................................ 2133
MinimumXYShearStrain ........................................................................................................ 2133
MinimumXZShearStrain ........................................................................................................ 2133
MinimumYZShearStrain ........................................................................................................ 2133
NormalXAxisStrain ................................................................................................................ 2134
NormalYAxisStrain ................................................................................................................ 2134
NormalZAxisStrain ................................................................................................................ 2134
Strain .................................................................................................................................... 2134
StrainIntensity ...................................................................................................................... 2134
XYShearStrain ....................................................................................................................... 2134
XZShearStrain ....................................................................................................................... 2135
YZShearStrain ....................................................................................................................... 2135
StressProbe ................................................................................................................................ 2135
DataModelObjectCategory ................................................................................................... 2138
EquivalentStress ................................................................................................................... 2139
InternalObject ...................................................................................................................... 2139
MaximumEquivalentStress .................................................................................................... 2139
MaximumMaximumPrincipalStress ....................................................................................... 2139
MaximumMiddlePrincipalStress ............................................................................................ 2139
MaximumMinimumPrincipalStress ........................................................................................ 2139
MaximumNormalXAxisStress ................................................................................................ 2140
MaximumNormalYAxisStress ................................................................................................. 2140
MaximumNormalZAxisStress ................................................................................................ 2140

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

MaximumPrincipalStress ....................................................................................................... 2140


MaximumStressIntensity ....................................................................................................... 2140
MaximumXYShearStress ....................................................................................................... 2140
MaximumXZShearStress ....................................................................................................... 2141
MaximumYZShearStress ....................................................................................................... 2141
MiddlePrincipalStress ............................................................................................................ 2141
MinimumEquivalentStress .................................................................................................... 2141
MinimumMaximumPrincipalStress ........................................................................................ 2141
MinimumMiddlePrincipalStress ............................................................................................. 2141
MinimumMinimumPrincipalStress ......................................................................................... 2142
MinimumNormalXAxisStress ................................................................................................. 2142
MinimumNormalYAxisStress ................................................................................................. 2142
MinimumNormalZAxisStress ................................................................................................. 2142
MinimumPrincipalStress ....................................................................................................... 2142
MinimumStressIntensity ....................................................................................................... 2142
MinimumXYShearStress ........................................................................................................ 2143
MinimumXZShearStress ........................................................................................................ 2143
MinimumYZShearStress ........................................................................................................ 2143
NormalXAxisStress ................................................................................................................ 2143
NormalYAxisStress ................................................................................................................ 2143
NormalZAxisStress ................................................................................................................ 2143
StressIntensity ...................................................................................................................... 2144
XCoordinate ......................................................................................................................... 2144
XYShearStress ....................................................................................................................... 2144
XZShearStress ....................................................................................................................... 2144
YCoordinate .......................................................................................................................... 2144
YZShearStress ....................................................................................................................... 2144
ZCoordinate ......................................................................................................................... 2145
TemperatureProbe ...................................................................................................................... 2145
DataModelObjectCategory ................................................................................................... 2148
InternalObject ...................................................................................................................... 2148
MaximumTemperature ......................................................................................................... 2148
MinimumTemperature .......................................................................................................... 2148
Temperature ......................................................................................................................... 2148
XCoordinate ......................................................................................................................... 2148
YCoordinate .......................................................................................................................... 2149
ZCoordinate ......................................................................................................................... 2149
TorqueProbe ............................................................................................................................... 2149
DataModelObjectCategory ................................................................................................... 2152
InternalObject ...................................................................................................................... 2152
VelocityProbe ............................................................................................................................. 2152
DataModelObjectCategory ................................................................................................... 2155
InternalObject ...................................................................................................................... 2155
VolumeProbe .............................................................................................................................. 2155
DataModelObjectCategory ................................................................................................... 2158
InternalObject ...................................................................................................................... 2158
MaximumVolume ................................................................................................................. 2158
MinimumVolume .................................................................................................................. 2158
VolumeResult ....................................................................................................................... 2158
XCoordinate ......................................................................................................................... 2159
YCoordinate .......................................................................................................................... 2159
ZCoordinate ......................................................................................................................... 2159

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

Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults Namespace .................. 2161


AccelerationFrequencyResponse ................................................................................................. 2161
DataModelObjectCategory ................................................................................................... 2164
InternalObject ...................................................................................................................... 2164
AcousticAWeightedSPLFrequencyResponse ................................................................................ 2165
DataModelObjectCategory ................................................................................................... 2167
InternalObject ...................................................................................................................... 2167
AcousticKineticEnergyFrequencyResponse .................................................................................. 2168
DataModelObjectCategory ................................................................................................... 2170
InternalObject ...................................................................................................................... 2171
AcousticPotentialEnergyFrequencyResponse .............................................................................. 2171
DataModelObjectCategory ................................................................................................... 2173
InternalObject ...................................................................................................................... 2174
AcousticPressureFrequencyResponse .......................................................................................... 2174
DataModelObjectCategory ................................................................................................... 2177
InternalObject ...................................................................................................................... 2177
AcousticSPLFrequencyResponse ................................................................................................. 2177
DataModelObjectCategory ................................................................................................... 2180
InternalObject ...................................................................................................................... 2180
ExportToWAVFile(string) ........................................................................................................ 2180
ExportToXMLFile(string) ........................................................................................................ 2180
AcousticVelocityFrequencyResponse ........................................................................................... 2181
DataModelObjectCategory ................................................................................................... 2183
InternalObject ...................................................................................................................... 2183
DeformationFrequencyResponse ................................................................................................ 2184
ContactRegion ...................................................................................................................... 2186
DataModelObjectCategory ................................................................................................... 2187
InternalObject ...................................................................................................................... 2187
ElasticStrainFrequencyResponse ................................................................................................. 2187
DataModelObjectCategory ................................................................................................... 2190
InternalObject ...................................................................................................................... 2190
EquivalentRadiatedPower ........................................................................................................... 2190
DataModelObjectCategory ................................................................................................... 2193
FrequencyRange ................................................................................................................... 2194
InternalObject ...................................................................................................................... 2194
MaximumFrequency ............................................................................................................. 2194
MinimumFrequency ............................................................................................................. 2194
EquivalentRadiatedPowerLevel ................................................................................................... 2194
DataModelObjectCategory ................................................................................................... 2198
FrequencyRange ................................................................................................................... 2198
InternalObject ...................................................................................................................... 2198
MaximumFrequency ............................................................................................................. 2198
MinimumFrequency ............................................................................................................. 2198
ExportToWAVFile(string) ........................................................................................................ 2199
ExportToXMLFile(string) ........................................................................................................ 2199
EquivalentRadiatedPowerLevelWaterfallDiagram ......................................................................... 2199
DataModelObjectCategory ................................................................................................... 2202
InternalObject ...................................................................................................................... 2203
ExportToWAVFile(string) ........................................................................................................ 2203
ExportToXMLFile(string) ........................................................................................................ 2203
EquivalentRadiatedPowerWaterfallDiagram ................................................................................ 2203
DataModelObjectCategory ................................................................................................... 2207

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

InternalObject ...................................................................................................................... 2207


StressFrequencyResponse ........................................................................................................... 2207
DataModelObjectCategory ................................................................................................... 2210
InternalObject ...................................................................................................................... 2210
VelocityFrequencyResponse ........................................................................................................ 2210
ContactRegion ...................................................................................................................... 2213
DataModelObjectCategory ................................................................................................... 2213
InternalObject ...................................................................................................................... 2213
Ansys.ACT.Automation.Mechanical.Results.FractureToolResults Namespace .............................. 2215
FractureCrackExtensionProbe ..................................................................................................... 2215
DataModelObjectCategory ................................................................................................... 2218
InternalObject ...................................................................................................................... 2218
MaximumValueOverTime ...................................................................................................... 2218
MinimumValueOverTime ...................................................................................................... 2218
ResultProbeValue .................................................................................................................. 2219
FractureEquivalentSIFSRangeProbe ............................................................................................. 2219
DataModelObjectCategory ................................................................................................... 2222
InternalObject ...................................................................................................................... 2222
MaximumValueOverTime ...................................................................................................... 2222
MinimumValueOverTime ...................................................................................................... 2222
ResultProbeValue .................................................................................................................. 2222
FractureJINTProbe ...................................................................................................................... 2222
DataModelObjectCategory ................................................................................................... 2225
InternalObject ...................................................................................................................... 2226
MaximumValueOverTime ...................................................................................................... 2226
MinimumValueOverTime ...................................................................................................... 2226
ResultProbeValue .................................................................................................................. 2226
FractureSIFSProbe ....................................................................................................................... 2226
DataModelObjectCategory ................................................................................................... 2229
FractureProbeSubType .......................................................................................................... 2229
InternalObject ...................................................................................................................... 2229
MaximumValueOverTime ...................................................................................................... 2230
MinimumValueOverTime ...................................................................................................... 2230
ResultProbeValue .................................................................................................................. 2230
FractureTool ............................................................................................................................... 2230
Children ............................................................................................................................... 2231
Comments ............................................................................................................................ 2232
CrackSelection ...................................................................................................................... 2232
CrackSelectionMode ............................................................................................................. 2232
DataModelObjectCategory ................................................................................................... 2232
Figures ................................................................................................................................. 2232
Images ................................................................................................................................. 2232
InternalObject ...................................................................................................................... 2233
Suppressed ........................................................................................................................... 2233
AddComment() ..................................................................................................................... 2233
AddCrackExtensionProbe() .................................................................................................... 2233
AddCStarIntegral() ................................................................................................................ 2233
AddEquivalentSIFSRange() .................................................................................................... 2233
AddEquivalentSIFSRangeProbe() ........................................................................................... 2234
AddFigure() .......................................................................................................................... 2234
AddImage(string) .................................................................................................................. 2234
AddJINT() .............................................................................................................................. 2234

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

AddJINTProbe() ..................................................................................................................... 2234


AddMaterialForceX() ............................................................................................................. 2234
AddMaterialForceY() ............................................................................................................. 2235
AddMaterialForceZ() ............................................................................................................. 2235
AddNumberOfCyclesProbe() ................................................................................................. 2235
AddSIFSK1() .......................................................................................................................... 2235
AddSIFSK1Probe() ................................................................................................................. 2235
AddSIFSK2() .......................................................................................................................... 2235
AddSIFSK2Probe() ................................................................................................................. 2236
AddSIFSK3() .......................................................................................................................... 2236
AddSIFSK3Probe() ................................................................................................................. 2236
AddTSTRESS() ....................................................................................................................... 2236
AddVCCTG1() ........................................................................................................................ 2236
AddVCCTG2() ........................................................................................................................ 2236
AddVCCTG3() ........................................................................................................................ 2237
AddVCCTGT() ........................................................................................................................ 2237
Delete() ................................................................................................................................ 2237
EvaluateAllResults() ............................................................................................................... 2237
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2237
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2238
FractureToolProbe ...................................................................................................................... 2238
ActiveContour ...................................................................................................................... 2241
CrackLengthPercentage ........................................................................................................ 2241
DataModelObjectCategory ................................................................................................... 2241
InternalObject ...................................................................................................................... 2241
FractureToolResult ...................................................................................................................... 2241
ActiveContour ...................................................................................................................... 2245
ActiveContourEnd ................................................................................................................ 2245
ActiveContourStart ............................................................................................................... 2245
DataModelObjectCategory ................................................................................................... 2245
FractureResultSubType ......................................................................................................... 2246
FractureResultType ............................................................................................................... 2246
InternalObject ...................................................................................................................... 2246
Mode .................................................................................................................................... 2246
FractureTotalNumberOfCyclesProbe ............................................................................................ 2246
DataModelObjectCategory ................................................................................................... 2249
InternalObject ...................................................................................................................... 2249
MaximumValueOverTime ...................................................................................................... 2249
MinimumValueOverTime ...................................................................................................... 2250
ResultProbeValue .................................................................................................................. 2250
Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults Namespace ............................... 2251
FatigueBiaxialityIndication .......................................................................................................... 2251
DataModelObjectCategory ................................................................................................... 2255
InternalObject ...................................................................................................................... 2255
FatigueDamage .......................................................................................................................... 2255
DataModelObjectCategory ................................................................................................... 2258
InternalObject ...................................................................................................................... 2259
FatigueDamageMatrix ................................................................................................................ 2259
Children ............................................................................................................................... 2260
Comments ............................................................................................................................ 2260
DataModelObjectCategory ................................................................................................... 2260
DesignLife ............................................................................................................................ 2260

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

Images ................................................................................................................................. 2260


InternalObject ...................................................................................................................... 2260
Location ............................................................................................................................... 2261
MaximumMean .................................................................................................................... 2261
MaximumRange ................................................................................................................... 2261
MinimumMean ..................................................................................................................... 2261
MinimumRange .................................................................................................................... 2261
OutputUnit ........................................................................................................................... 2261
Suppressed ........................................................................................................................... 2262
AddComment() ..................................................................................................................... 2262
AddImage(string) .................................................................................................................. 2262
Delete() ................................................................................................................................ 2262
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2262
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2263
FatigueEquivalentAlternativeStress ............................................................................................. 2263
DataModelObjectCategory ................................................................................................... 2267
InternalObject ...................................................................................................................... 2267
FatigueHysteresis ........................................................................................................................ 2267
DataModelObjectCategory ................................................................................................... 2270
InternalObject ...................................................................................................................... 2270
MaximumStrain .................................................................................................................... 2270
MaximumStress .................................................................................................................... 2270
MinimumStrain ..................................................................................................................... 2270
MinimumStress ..................................................................................................................... 2271
PointsPerSegment ................................................................................................................ 2271
FatigueLife .................................................................................................................................. 2271
DataModelObjectCategory ................................................................................................... 2274
InternalObject ...................................................................................................................... 2275
FatigueRainflowMatrix ................................................................................................................ 2275
Children ............................................................................................................................... 2276
Comments ............................................................................................................................ 2276
DataModelObjectCategory ................................................................................................... 2276
Images ................................................................................................................................. 2276
InternalObject ...................................................................................................................... 2276
Location ............................................................................................................................... 2276
MaximumMean .................................................................................................................... 2277
MaximumRange ................................................................................................................... 2277
MinimumMean ..................................................................................................................... 2277
MinimumRange .................................................................................................................... 2277
OutputUnit ........................................................................................................................... 2277
Suppressed ........................................................................................................................... 2277
AddComment() ..................................................................................................................... 2278
AddImage(string) .................................................................................................................. 2278
Delete() ................................................................................................................................ 2278
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2278
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2278
FatigueSafetyFactor .................................................................................................................... 2279
DataModelObjectCategory ................................................................................................... 2282
InternalObject ...................................................................................................................... 2282
FatigueSensitivity ....................................................................................................................... 2283
ChartViewingStyle ................................................................................................................ 2283
Children ............................................................................................................................... 2284

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

Comments ............................................................................................................................ 2284


DataModelObjectCategory ................................................................................................... 2284
Images ................................................................................................................................. 2284
InternalObject ...................................................................................................................... 2284
Location ............................................................................................................................... 2284
LowerVariation ..................................................................................................................... 2285
NumberOfFillPoints .............................................................................................................. 2285
Sensitivity ............................................................................................................................. 2285
Suppressed ........................................................................................................................... 2285
UpperVariation ..................................................................................................................... 2285
AddComment() ..................................................................................................................... 2285
AddImage(string) .................................................................................................................. 2286
Delete() ................................................................................................................................ 2286
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2286
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2286
FatigueToolResult ....................................................................................................................... 2287
AverageAcrossBodies ............................................................................................................ 2290
DataModelObjectCategory ................................................................................................... 2290
DesignLife ............................................................................................................................ 2290
InternalObject ...................................................................................................................... 2291
Method ................................................................................................................................ 2291
Ansys.ACT.Automation.Mechanical.Results.AcousticResults Namespace ..................................... 2293
AcousticAbsorptionCoefficient .................................................................................................... 2293
DataModelObjectCategory ................................................................................................... 2297
FrequencyRange ................................................................................................................... 2298
InputPort .............................................................................................................................. 2298
InternalObject ...................................................................................................................... 2298
MaximumFrequency ............................................................................................................. 2298
MinimumFrequency ............................................................................................................. 2298
AcousticAWeightedSoundPressureLevel ...................................................................................... 2298
DataModelObjectCategory ................................................................................................... 2302
InternalObject ...................................................................................................................... 2302
AcousticDiffuseSoundTransmissionLoss ...................................................................................... 2303
DataModelObjectCategory ................................................................................................... 2307
FrequencyRange ................................................................................................................... 2307
InternalObject ...................................................................................................................... 2307
MaximumFrequency ............................................................................................................. 2307
MinimumFrequency ............................................................................................................. 2307
AcousticDirectionalVelocityResult ............................................................................................... 2307
DataModelObjectCategory ................................................................................................... 2311
InternalObject ...................................................................................................................... 2311
NormalOrientation ................................................................................................................ 2312
AcousticFarFieldResult ................................................................................................................ 2312
DampedFrequency ............................................................................................................... 2316
DataModelObjectCategory ................................................................................................... 2316
Density ................................................................................................................................. 2316
EndingRadiationAnglePhi ..................................................................................................... 2316
EndingRadiationAngleTheta ................................................................................................. 2317
FarFieldMicrophoneDefinitionMethod .................................................................................. 2317
InternalObject ...................................................................................................................... 2317
LogarithmicDecrement ......................................................................................................... 2317
ModalDampingRatio ............................................................................................................. 2317

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

ModelThicknessInZDirection ................................................................................................. 2317


ModelType ........................................................................................................................... 2318
PhiAngleEnd ......................................................................................................................... 2318
PhiAngleNoOfDivisions ......................................................................................................... 2318
PhiAngleStart ....................................................................................................................... 2318
ReferenceRMSSoundPressure ................................................................................................ 2318
ReferenceSoundPower .......................................................................................................... 2318
ReportedFrequency .............................................................................................................. 2319
SoundSpeed ......................................................................................................................... 2319
SpatialRadiationAngle .......................................................................................................... 2319
SphereRadius ....................................................................................................................... 2319
Stability ................................................................................................................................ 2319
StartingRadiationAnglePhi .................................................................................................... 2319
StartingRadiationAngleTheta ................................................................................................ 2320
ThetaAngleEnd ..................................................................................................................... 2320
ThetaAngleNoOfDivisions ..................................................................................................... 2320
ThetaAngleStart ................................................................................................................... 2320
Worksheet ............................................................................................................................ 2320
XCoordinate ......................................................................................................................... 2320
YAxisExtrusionAngle ............................................................................................................. 2321
YCoordinate .......................................................................................................................... 2321
ZCoordinate ......................................................................................................................... 2321
ExportToWAVFile(string) ........................................................................................................ 2321
ExportToXMLFile(string) ........................................................................................................ 2321
AcousticFarFieldSoundPowerLevelWaterfallDiagram ................................................................... 2322
DataModelObjectCategory ................................................................................................... 2327
InternalObject ...................................................................................................................... 2328
AcousticFarFieldSPLMicWaterfallDiagram .................................................................................... 2328
DataModelObjectCategory ................................................................................................... 2333
InternalObject ...................................................................................................................... 2334
AcousticFrequencyBandAWeightedSPL ....................................................................................... 2334
DataModelObjectCategory ................................................................................................... 2338
InternalObject ...................................................................................................................... 2338
AcousticFrequencyBandSPL ........................................................................................................ 2338
DataModelObjectCategory ................................................................................................... 2342
InternalObject ...................................................................................................................... 2342
AcousticKineticEnergy ................................................................................................................ 2342
DataModelObjectCategory ................................................................................................... 2346
InternalObject ...................................................................................................................... 2346
AcousticPotentialEnergy ............................................................................................................. 2346
DataModelObjectCategory ................................................................................................... 2350
InternalObject ...................................................................................................................... 2350
AcousticPressureResult ............................................................................................................... 2350
DataModelObjectCategory ................................................................................................... 2354
InternalObject ...................................................................................................................... 2354
AcousticResult ............................................................................................................................ 2355
Amplitude ............................................................................................................................ 2358
DampedFrequency ............................................................................................................... 2358
DataModelObjectCategory ................................................................................................... 2358
Frequency ............................................................................................................................ 2359
InternalObject ...................................................................................................................... 2359
LogarithmicDecrement ......................................................................................................... 2359

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

ModalDampingRatio ............................................................................................................. 2359


Mode .................................................................................................................................... 2359
ReportedFrequency .............................................................................................................. 2359
Stability ................................................................................................................................ 2360
SweepingPhase .................................................................................................................... 2360
AcousticReturnLoss ..................................................................................................................... 2360
DataModelObjectCategory ................................................................................................... 2364
FrequencyRange ................................................................................................................... 2364
InputPort .............................................................................................................................. 2364
InternalObject ...................................................................................................................... 2364
MaximumFrequency ............................................................................................................. 2365
MinimumFrequency ............................................................................................................. 2365
AcousticSoundPressureLevel ....................................................................................................... 2365
DataModelObjectCategory ................................................................................................... 2369
InternalObject ...................................................................................................................... 2369
AcousticTotalVelocityResult ......................................................................................................... 2369
DataModelObjectCategory ................................................................................................... 2373
InternalObject ...................................................................................................................... 2373
AcousticTransmissionLoss ........................................................................................................... 2373
DataModelObjectCategory ................................................................................................... 2377
FrequencyRange ................................................................................................................... 2377
InputPort .............................................................................................................................. 2378
InternalObject ...................................................................................................................... 2378
MaximumFrequency ............................................................................................................. 2378
MinimumFrequency ............................................................................................................. 2378
OutputPort ........................................................................................................................... 2378
Ansys.ACT.Automation.Mechanical.ImportedLoads Namespace .................................................. 2379
ImportedBodyForceDensity ........................................................................................................ 2379
DataModelObjectCategory ................................................................................................... 2380
InternalObject ...................................................................................................................... 2380
ImportedBodyTemperature ......................................................................................................... 2380
DataModelObjectCategory ................................................................................................... 2381
InternalObject ...................................................................................................................... 2381
ImportedConvection ................................................................................................................... 2381
DataModelObjectCategory ................................................................................................... 2382
DisplayConnectionLines ........................................................................................................ 2382
FluidFlow .............................................................................................................................. 2382
FluidFlowLocation ................................................................................................................ 2383
InternalObject ...................................................................................................................... 2383
ImportedCutBoundaryRemoteConstraint .................................................................................... 2383
DataModelObjectCategory ................................................................................................... 2384
InternalObject ...................................................................................................................... 2384
ImportedCutBoundaryRemoteForce ............................................................................................ 2384
DataModelObjectCategory ................................................................................................... 2385
InternalObject ...................................................................................................................... 2385
ImportedDisplacement ............................................................................................................... 2385
DataModelObjectCategory ................................................................................................... 2386
InternalObject ...................................................................................................................... 2386
ImportedLoad ............................................................................................................................ 2386
ApplyAs ................................................................................................................................ 2387
Children ............................................................................................................................... 2387
Comments ............................................................................................................................ 2387

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

DataModelObjectCategory ................................................................................................... 2387


Figures ................................................................................................................................. 2388
Images ................................................................................................................................. 2388
InternalObject ...................................................................................................................... 2388
Location ............................................................................................................................... 2388
Suppressed ........................................................................................................................... 2388
AddComment() ..................................................................................................................... 2388
AddFigure() .......................................................................................................................... 2389
AddImage(string) .................................................................................................................. 2389
ClearGeneratedData() ........................................................................................................... 2389
Delete() ................................................................................................................................ 2389
ExportToTextFile(string) ........................................................................................................ 2389
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2390
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2390
Import() ................................................................................................................................ 2390
ImportLoad() ........................................................................................................................ 2391
ImportedLoadGroup ................................................................................................................... 2391
Children ............................................................................................................................... 2392
Comments ............................................................................................................................ 2392
DataModelObjectCategory ................................................................................................... 2392
DeleteMappedDataFilesAfterImport ...................................................................................... 2393
Figures ................................................................................................................................. 2393
Images ................................................................................................................................. 2393
InternalObject ...................................................................................................................... 2393
ResultFile .............................................................................................................................. 2393
ResultFileTimestamp ............................................................................................................. 2393
ResultFileUnitSystem ............................................................................................................ 2394
SourceDimension ................................................................................................................. 2394
Suppressed ........................................................................................................................... 2394
TransferStep ......................................................................................................................... 2394
TransferTemperaturesDuringSolve ........................................................................................ 2394
AddComment() ..................................................................................................................... 2394
AddFigure() .......................................................................................................................... 2395
AddImage(string) .................................................................................................................. 2395
AddImportedBodyForceDensity() .......................................................................................... 2395
AddImportedBodyTemperature() .......................................................................................... 2395
AddImportedCutBoundaryConstraint() .................................................................................. 2395
AddImportedCutBoundaryRemoteConstraint() ...................................................................... 2396
AddImportedCutBoundaryRemoteForce() ............................................................................. 2396
AddImportedDisplacement() ................................................................................................. 2396
AddImportedSurfaceForceDensity() ...................................................................................... 2396
AddImportedTemperature() .................................................................................................. 2396
AddImportedVelocity() ......................................................................................................... 2396
ClearGeneratedData() ........................................................................................................... 2397
CreateBodyForceDensitiesAndSyncAnalysisSettings() ............................................................ 2397
CreateExternalLoadVelocitiesAndSyncAnalysisSettings() ........................................................ 2397
CreateSurfaceForceDensitiesAndSyncAnalysisSettings() ........................................................ 2397
Delete() ................................................................................................................................ 2397
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2397
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2398
ImportLoad() ........................................................................................................................ 2398
RefreshImportedLoad() ......................................................................................................... 2398

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

SetResultFile(string, WBUnitSystemType) ............................................................................... 2398


ImportedSurfaceForceDensity ..................................................................................................... 2399
DataModelObjectCategory ................................................................................................... 2400
InternalObject ...................................................................................................................... 2400
ImportedTemperature ................................................................................................................ 2400
DataModelObjectCategory ................................................................................................... 2401
InternalObject ...................................................................................................................... 2401
ImportedTrace ............................................................................................................................ 2401
DataModelObjectCategory ................................................................................................... 2402
InternalObject ...................................................................................................................... 2402
Layers ................................................................................................................................... 2402
Vias ...................................................................................................................................... 2402
ImportedVelocity ........................................................................................................................ 2402
DataModelObjectCategory ................................................................................................... 2403
InternalObject ...................................................................................................................... 2403
Ansys.ACT.Automation.Mechanical.FE Namespace ....................................................................... 2405
Command .................................................................................................................................. 2405
Index .................................................................................................................................... 2405
Name ................................................................................................................................... 2406
CommandColl ............................................................................................................................. 2406
Count ................................................................................................................................... 2406
Item(uint) ............................................................................................................................. 2406
CommandRepository .................................................................................................................. 2406
GetCommandByIndex(int) .................................................................................................... 2407
GetCommandName(CommandsType, int) .............................................................................. 2407
GetCommandNames(CommandsType) ................................................................................. 2408
GetCommandNamesCount(CommandsType) ........................................................................ 2408
GetCommandsByName(string) .............................................................................................. 2408
CommandsType .......................................................................................................................... 2408
FEParser ...................................................................................................................................... 2409
FEParser() ............................................................................................................................. 2409
Ansys.ACT.Automation.Mechanical.FE.NASTRAN Namespace ...................................................... 2411
CaseControlCommand ................................................................................................................ 2411
Text ...................................................................................................................................... 2411
GenericCommand ....................................................................................................................... 2412
Arguments ........................................................................................................................... 2412
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace ............................................................... 2413
BeamSecBlockCommand ............................................................................................................ 2414
Cells ..................................................................................................................................... 2415
Nodes ................................................................................................................................... 2415
Type ..................................................................................................................................... 2415
CECMODCommand .................................................................................................................... 2415
Constant ............................................................................................................................... 2416
Nce ....................................................................................................................................... 2416
CECommand .............................................................................................................................. 2416
Constant ............................................................................................................................... 2417
Nce ....................................................................................................................................... 2417
Terms ................................................................................................................................... 2417
CMBlockCommand ..................................................................................................................... 2417
Cmname ............................................................................................................................... 2418
Elements .............................................................................................................................. 2418
Type ..................................................................................................................................... 2418

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

CMEDITCommand ...................................................................................................................... 2418


Aname ................................................................................................................................. 2419
Cnames ................................................................................................................................ 2419
Oper ..................................................................................................................................... 2419
CMGRPCommand ....................................................................................................................... 2419
Aname ................................................................................................................................. 2420
Cnames ................................................................................................................................ 2420
CommandCell ............................................................................................................................. 2420
MatId .................................................................................................................................... 2420
Nodes ................................................................................................................................... 2421
CommandCETerm ....................................................................................................................... 2421
Coefficient ............................................................................................................................ 2421
Dof ....................................................................................................................................... 2421
Node .................................................................................................................................... 2421
CommandElement ...................................................................................................................... 2422
Csys ...................................................................................................................................... 2422
Id ......................................................................................................................................... 2422
Mat ...................................................................................................................................... 2423
NodeCount ........................................................................................................................... 2423
Nodes ................................................................................................................................... 2423
Real ...................................................................................................................................... 2423
Section ................................................................................................................................. 2423
Type ..................................................................................................................................... 2423
CommandKeyOpt ....................................................................................................................... 2424
Knum ................................................................................................................................... 2424
Value .................................................................................................................................... 2424
CommandLayer .......................................................................................................................... 2424
Mat ...................................................................................................................................... 2425
Numpt .................................................................................................................................. 2425
Theta .................................................................................................................................... 2425
Thick .................................................................................................................................... 2425
CommandNode .......................................................................................................................... 2425
Id ......................................................................................................................................... 2426
Location ............................................................................................................................... 2426
Rotation ............................................................................................................................... 2426
CommandReal ............................................................................................................................ 2426
Id ......................................................................................................................................... 2426
Values ................................................................................................................................... 2427
CPCommand .............................................................................................................................. 2427
Dof ....................................................................................................................................... 2427
Ncp ...................................................................................................................................... 2427
Nodes ................................................................................................................................... 2428
EBlockCommand ........................................................................................................................ 2428
Elements .............................................................................................................................. 2428
ENCommand .............................................................................................................................. 2428
Type ..................................................................................................................................... 2429
Values ................................................................................................................................... 2429
ETCommand ............................................................................................................................... 2429
Ename .................................................................................................................................. 2430
Id ......................................................................................................................................... 2430
Keyopts ................................................................................................................................ 2430
GenericCommand ....................................................................................................................... 2430

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

Arguments ........................................................................................................................... 2431


LocalCommand .......................................................................................................................... 2431
Cstyp .................................................................................................................................... 2432
Ncsy ..................................................................................................................................... 2432
Type ..................................................................................................................................... 2432
Values ................................................................................................................................... 2432
MPCommand ............................................................................................................................. 2432
C0 ........................................................................................................................................ 2433
C1 ........................................................................................................................................ 2433
C2 ........................................................................................................................................ 2434
C3 ........................................................................................................................................ 2434
C4 ........................................................................................................................................ 2434
Lab ....................................................................................................................................... 2434
Mat ...................................................................................................................................... 2434
MPDataCommand ...................................................................................................................... 2434
Lab ....................................................................................................................................... 2435
Mat ...................................................................................................................................... 2435
Temps .................................................................................................................................. 2435
Values ................................................................................................................................... 2436
NBlockCommand ........................................................................................................................ 2436
Nodes ................................................................................................................................... 2436
NCommand ................................................................................................................................ 2436
Node .................................................................................................................................... 2437
Type ..................................................................................................................................... 2437
Values ................................................................................................................................... 2437
PreadCommand .......................................................................................................................... 2438
Aname ................................................................................................................................. 2438
Values ................................................................................................................................... 2438
RCommand ................................................................................................................................ 2438
Nset ...................................................................................................................................... 2439
Stloc ..................................................................................................................................... 2439
Values ................................................................................................................................... 2439
RLBlockCommand ...................................................................................................................... 2440
Reals ..................................................................................................................................... 2440
SecdataCommand ...................................................................................................................... 2440
Values ................................................................................................................................... 2441
SecoffsetCommand .................................................................................................................... 2441
Location ............................................................................................................................... 2441
Values ................................................................................................................................... 2441
SectypeCommand ...................................................................................................................... 2442
RefineKey ............................................................................................................................. 2442
Secid .................................................................................................................................... 2442
Secname .............................................................................................................................. 2443
Subtype ................................................................................................................................ 2443
Type ..................................................................................................................................... 2443
SFECommand ............................................................................................................................. 2443
Elem ..................................................................................................................................... 2444
Key ....................................................................................................................................... 2444
Lab ....................................................................................................................................... 2444
LKey ..................................................................................................................................... 2444
Values ................................................................................................................................... 2444
ShellSecBlockCommand ............................................................................................................. 2445

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

Layers ................................................................................................................................... 2445


Type ..................................................................................................................................... 2445
Ansys.ACT.Automation.Mechanical.FE.ABAQUS Namespace ........................................................ 2447
AbaqusKeyword ......................................................................................................................... 2447
Arguments ........................................................................................................................... 2448
DataLines ............................................................................................................................. 2448
AbaqusKeywordArgument .......................................................................................................... 2448
Key ....................................................................................................................................... 2448
Value .................................................................................................................................... 2448
AbaqusKeywordArgumentColl .................................................................................................... 2449
Items .................................................................................................................................... 2449
AbaqusKeywordDataLine ............................................................................................................ 2449
Items .................................................................................................................................... 2449
AbaqusKeywordDataLineColl ...................................................................................................... 2449
Items .................................................................................................................................... 2450
Ansys.ACT.Automation.Mechanical.Connections Namespace ....................................................... 2451
Beam .......................................................................................................................................... 2451
BeamElementAPDLName ...................................................................................................... 2453
Children ............................................................................................................................... 2453
Comments ............................................................................................................................ 2453
CrossSection ......................................................................................................................... 2453
DataModelObjectCategory ................................................................................................... 2453
Figures ................................................................................................................................. 2453
Images ................................................................................................................................. 2454
InternalObject ...................................................................................................................... 2454
Material ................................................................................................................................ 2454
MobileAppliedBy .................................................................................................................. 2454
MobileBeamMaterial ............................................................................................................. 2454
MobileBeamRadius ............................................................................................................... 2454
MobileBehavior .................................................................................................................... 2455
MobileBody .......................................................................................................................... 2455
MobileCoordinateSystem ...................................................................................................... 2455
MobileLocation ..................................................................................................................... 2455
MobilePinballRegion ............................................................................................................. 2455
MobileXCoordinate ............................................................................................................... 2455
MobileYCoordinate ............................................................................................................... 2456
MobileZCoordinate ............................................................................................................... 2456
Radius .................................................................................................................................. 2456
ReferenceAppliedBy ............................................................................................................. 2456
ReferenceBeamMaterial ........................................................................................................ 2456
ReferenceBeamRadius .......................................................................................................... 2456
ReferenceBehavior ................................................................................................................ 2457
ReferenceBody ..................................................................................................................... 2457
ReferenceCoordinateSystem ................................................................................................. 2457
ReferenceLocation ................................................................................................................ 2457
ReferenceLocationPoint ........................................................................................................ 2457
ReferencePinballRegion ........................................................................................................ 2457
ReferenceXCoordinate .......................................................................................................... 2458
ReferenceYCoordinate .......................................................................................................... 2458
ReferenceZCoordinate .......................................................................................................... 2458
Scope ................................................................................................................................... 2458
Suppressed ........................................................................................................................... 2458

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

Visible .................................................................................................................................. 2458


AddComment() ..................................................................................................................... 2459
AddFigure() .......................................................................................................................... 2459
AddImage(string) .................................................................................................................. 2459
Delete() ................................................................................................................................ 2459
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2459
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2460
PromoteToNamedSelection() ................................................................................................ 2460
PromoteToRemotePoint() ...................................................................................................... 2460
Bearing ....................................................................................................................................... 2461
AnsBCType ........................................................................................................................... 2462
Children ............................................................................................................................... 2462
Comments ............................................................................................................................ 2462
ConnectionType ................................................................................................................... 2463
DampingC11 ........................................................................................................................ 2463
DampingC12 ........................................................................................................................ 2463
DampingC21 ........................................................................................................................ 2463
DampingC22 ........................................................................................................................ 2463
DataModelObjectCategory ................................................................................................... 2463
Figures ................................................................................................................................. 2464
Images ................................................................................................................................. 2464
InternalObject ...................................................................................................................... 2464
MobileBeamMaterial ............................................................................................................. 2464
MobileBeamRadius ............................................................................................................... 2464
MobileBehavior .................................................................................................................... 2464
MobileBody .......................................................................................................................... 2465
MobileCoordinateSystem ...................................................................................................... 2465
MobileLocation ..................................................................................................................... 2465
MobilePinballSize ................................................................................................................. 2465
MobileXCoordinate ............................................................................................................... 2465
MobileYCoordinate ............................................................................................................... 2465
MobileZCoordinate ............................................................................................................... 2466
ReferenceBeamMaterial ........................................................................................................ 2466
ReferenceBeamRadius .......................................................................................................... 2466
ReferenceBehavior ................................................................................................................ 2466
ReferenceBodyName ............................................................................................................ 2466
ReferenceCoordinateSystem ................................................................................................. 2466
ReferenceLocation ................................................................................................................ 2467
ReferencePinballRegion ........................................................................................................ 2467
ReferenceRotationPlane ........................................................................................................ 2467
ReferenceSet ***OBSOLETE*** Use 'ReferenceLocation' property instead. ............................... 2467
ReferenceXCoordinate .......................................................................................................... 2467
ReferenceYCoordinate .......................................................................................................... 2467
ReferenceZCoordinate .......................................................................................................... 2468
StiffnessK11 .......................................................................................................................... 2468
StiffnessK12 .......................................................................................................................... 2468
StiffnessK21 .......................................................................................................................... 2468
StiffnessK22 .......................................................................................................................... 2468
Suppressed ........................................................................................................................... 2468
AddComment() ..................................................................................................................... 2469
AddFigure() .......................................................................................................................... 2469
AddImage(string) .................................................................................................................. 2469

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

Delete() ................................................................................................................................ 2469


GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2469
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2470
PromoteToNamedSelection() ................................................................................................ 2470
PromoteToRemotePoint() ...................................................................................................... 2470
BodyInteraction .......................................................................................................................... 2471
Breakable ............................................................................................................................. 2472
Children ............................................................................................................................... 2472
Comments ............................................................................................................................ 2472
ContactType ......................................................................................................................... 2472
DataModelObjectCategory ................................................................................................... 2472
DecayConstant ..................................................................................................................... 2472
DynamicCoefficient .............................................................................................................. 2473
Figures ................................................................................................................................. 2473
FrictionCoefficient ................................................................................................................ 2473
Images ................................................................................................................................. 2473
InternalObject ...................................................................................................................... 2473
Location ............................................................................................................................... 2473
MaximumOffset .................................................................................................................... 2474
NormalForceExponent .......................................................................................................... 2474
NormalForceLimit ................................................................................................................. 2474
NormalStressExponent ......................................................................................................... 2474
NormalStressLimit ................................................................................................................ 2474
ShearForceExponent ............................................................................................................. 2474
ShearForceLimit .................................................................................................................... 2475
ShearStressExponent ............................................................................................................ 2475
ShearStressLimit ................................................................................................................... 2475
Suppressed ........................................................................................................................... 2475
AddComment() ..................................................................................................................... 2475
AddFigure() .......................................................................................................................... 2475
AddImage(string) .................................................................................................................. 2476
Delete() ................................................................................................................................ 2476
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2476
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2476
BodyInteractions ........................................................................................................................ 2477
BodySelfContact ................................................................................................................... 2478
Children ............................................................................................................................... 2478
Comments ............................................................................................................................ 2478
ContactDetection ................................................................................................................. 2478
DataModelObjectCategory ................................................................................................... 2478
EdgeOnEdgeContact ............................................................................................................ 2479
ElementSelfContact .............................................................................................................. 2479
Figures ................................................................................................................................. 2479
Formulation .......................................................................................................................... 2479
Images ................................................................................................................................. 2479
InternalObject ...................................................................................................................... 2479
LimitingTimestepVelocity ...................................................................................................... 2480
ManualContactTreatment ..................................................................................................... 2480
NodalShellThickness ............................................................................................................. 2480
PinballFactor ......................................................................................................................... 2480
ShellThicknessFactor ............................................................................................................. 2480
SlidingContact ...................................................................................................................... 2480

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

TimestepSafetyFactor ........................................................................................................... 2481


Tolerance .............................................................................................................................. 2481
AddBodyInteraction() ............................................................................................................ 2481
AddComment() ..................................................................................................................... 2481
AddFigure() .......................................................................................................................... 2481
AddImage(string) .................................................................................................................. 2481
Delete() ................................................................................................................................ 2482
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2482
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2482
ConnectionGroup ....................................................................................................................... 2483
ActiveConnections ................................................................................................................ 2484
AutomaticFixedJoints ........................................................................................................... 2484
Children ............................................................................................................................... 2484
Comments ............................................................................................................................ 2485
Connections ......................................................................................................................... 2485
ConnectionType ................................................................................................................... 2485
CylindricalFaces .................................................................................................................... 2485
DataModelObjectCategory ................................................................................................... 2485
EdgeEdge ............................................................................................................................. 2485
EdgeOverlapTolerance .......................................................................................................... 2486
FaceAngleTolerance .............................................................................................................. 2486
FaceEdge .............................................................................................................................. 2486
FaceFace ............................................................................................................................... 2486
FaceFaceDetectionAngleTolerence ........................................................................................ 2486
FaceOverlapTolerance ........................................................................................................... 2486
Figures ................................................................................................................................. 2487
GroupBy ............................................................................................................................... 2487
Images ................................................................................................................................. 2487
InternalObject ...................................................................................................................... 2487
Location ............................................................................................................................... 2487
MinimumDistancePercentage ............................................................................................... 2487
MinimumDistanceValue ........................................................................................................ 2488
Priority ................................................................................................................................. 2488
RevoluteJoints ...................................................................................................................... 2488
SearchAcross ........................................................................................................................ 2488
Suppressed ........................................................................................................................... 2488
ThicknessScaleFactor ............................................................................................................ 2488
ToleranceSlider ..................................................................................................................... 2489
ToleranceType ...................................................................................................................... 2489
ToleranceValue ..................................................................................................................... 2489
UseRange ............................................................................................................................. 2489
AddComment() ..................................................................................................................... 2489
AddContactRegion() ............................................................................................................. 2489
AddFigure() .......................................................................................................................... 2490
AddImage(string) .................................................................................................................. 2490
AddJoint() ............................................................................................................................. 2490
AddSpotWeld() ..................................................................................................................... 2490
CreateAutomaticConnections() ............................................................................................. 2490
Delete() ................................................................................................................................ 2491
DeleteChildren() ................................................................................................................... 2491
DeleteChildren(bool) ............................................................................................................ 2491
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2491

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

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2491


RepairOverlappingContactRegions() ..................................................................................... 2492
SearchConnectionsForDuplicatePairs() .................................................................................. 2492
Connections ............................................................................................................................... 2492
Children ............................................................................................................................... 2493
Comments ............................................................................................................................ 2494
DataModelObjectCategory ................................................................................................... 2494
Figures ................................................................................................................................. 2494
FixedJoints ........................................................................................................................... 2494
GenerateAutomaticConnectionOnRefresh ............................................................................. 2494
Images ................................................................................................................................. 2494
InternalObject ...................................................................................................................... 2495
SolverFilesDirectory .............................................................................................................. 2495
TransparencyEnabled ............................................................................................................ 2495
AddBeam() ........................................................................................................................... 2495
AddBearing() ........................................................................................................................ 2495
AddBodyInteraction() ............................................................................................................ 2495
AddComment() ..................................................................................................................... 2496
AddConnectionGroup() ......................................................................................................... 2496
AddContactRegion() ............................................................................................................. 2496
AddContactSolutionInformation() ......................................................................................... 2496
AddContactTool() .................................................................................................................. 2496
AddEndRelease() ................................................................................................................... 2496
AddFigure() .......................................................................................................................... 2497
AddImage(string) .................................................................................................................. 2497
AddJoint() ............................................................................................................................. 2497
AddSpotWeld() ..................................................................................................................... 2497
AddSpring() .......................................................................................................................... 2497
CreateAutomaticConnections() ............................................................................................. 2498
ExportModelTopology(string) ............................................................................................... 2498
GenerateInitialContactResults() ............................................................................................. 2498
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2498
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2498
RepairOverlappingContactRegions() ..................................................................................... 2499
SearchConnectionsForDuplicatePairs() .................................................................................. 2499
ContactRegion ............................................................................................................................ 2499
AutomaticDetectionValue ..................................................................................................... 2502
AutomaticElectricConductance ............................................................................................. 2503
AutomaticNormalStiffness ***OBSOLETE*** Use 'NormalStiffnessValueType' property in-
stead. ................................................................................................................................... 2503
AutomaticThermalConductance ............................................................................................ 2503
BeamBeamDetection ............................................................................................................ 2503
BeamMaterialName ***OBSOLETE*** Use 'Material' property instead. .................................... 2503
BeamRadius .......................................................................................................................... 2503
Behavior ............................................................................................................................... 2504
BondedMaximumOffset ........................................................................................................ 2504
Breakable ............................................................................................................................. 2504
Children ............................................................................................................................... 2504
Comments ............................................................................................................................ 2504
ConstraintType ..................................................................................................................... 2504
ContactBodies ...................................................................................................................... 2505
ContactCenterPoint .............................................................................................................. 2505

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

ContactEndingPoint .............................................................................................................. 2505


ContactFormulation .............................................................................................................. 2505
ContactGeometryCorrection ................................................................................................. 2505
ContactOrientation ............................................................................................................... 2505
ContactShellFace .................................................................................................................. 2506
ContactStartingPoint ............................................................................................................ 2506
ContactType ......................................................................................................................... 2506
DataModelObjectCategory ................................................................................................... 2506
DecayConstant ..................................................................................................................... 2506
DetectionMethod ................................................................................................................. 2506
DisplayElementNormal ......................................................................................................... 2507
DynamicCoefficient .............................................................................................................. 2507
ElasticSlipTolerance .............................................................................................................. 2507
ElasticSlipToleranceFactor ..................................................................................................... 2507
ElasticSlipToleranceValue ...................................................................................................... 2507
ElectricConductanceValue ..................................................................................................... 2507
Figures ................................................................................................................................. 2508
FlipContact ........................................................................................................................... 2508
FlipTarget ............................................................................................................................. 2508
FrictionCoefficient ................................................................................................................ 2508
Handedness ......................................................................................................................... 2508
Images ................................................................................................................................. 2508
InitialClearance ..................................................................................................................... 2509
InitialClearanceFactor ........................................................................................................... 2509
InitialClearanceValue ............................................................................................................. 2509
InterfaceTreatment ............................................................................................................... 2509
InternalObject ...................................................................................................................... 2509
Material ................................................................................................................................ 2509
MeanPitchDiameter .............................................................................................................. 2510
NormalForceExponent .......................................................................................................... 2510
NormalForceLimit ................................................................................................................. 2510
NormalStiffnessFactor ........................................................................................................... 2510
NormalStiffnessValue ............................................................................................................ 2510
NormalStiffnessValueType ..................................................................................................... 2510
NormalStressExponent ......................................................................................................... 2511
NormalStressLimit ................................................................................................................ 2511
PenetrationTolerance ............................................................................................................ 2511
PenetrationToleranceFactor .................................................................................................. 2511
PenetrationToleranceValue ................................................................................................... 2511
PinballFactor ......................................................................................................................... 2511
PinballRadius ........................................................................................................................ 2512
PinballRegion ....................................................................................................................... 2512
PitchDistance ........................................................................................................................ 2512
PressureAtZeroPenetration ................................................................................................... 2512
PressureAtZeroPenetrationFactor .......................................................................................... 2512
PressureAtZeroPenetrationValue ........................................................................................... 2512
Protected .............................................................................................................................. 2513
RBDContactDetection ........................................................................................................... 2513
RestitutionFactor .................................................................................................................. 2513
ScopeMode .......................................................................................................................... 2513
ShearForceExponent ............................................................................................................. 2513
ShearForceLimit .................................................................................................................... 2513

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

ShearStressExponent ............................................................................................................ 2514


ShearStressLimit ................................................................................................................... 2514
ShellThicknessEffect ............................................................................................................. 2514
SmallSliding .......................................................................................................................... 2514
SourceLocation ..................................................................................................................... 2514
StabilizationDampingFactor .................................................................................................. 2514
Suppressed ........................................................................................................................... 2515
TargetBodies ......................................................................................................................... 2515
TargetCenterPoint ................................................................................................................. 2515
TargetEndingPoint ................................................................................................................ 2515
TargetGeometryCorrection ................................................................................................... 2515
TargetLocation ...................................................................................................................... 2515
TargetOrientation ................................................................................................................. 2516
TargetShellFace ..................................................................................................................... 2516
TargetStartingPoint ............................................................................................................... 2516
ThermalConductanceValue ................................................................................................... 2516
ThreadAngle ......................................................................................................................... 2516
ThreadType .......................................................................................................................... 2516
TimeStepControls ................................................................................................................. 2517
TrimContact .......................................................................................................................... 2517
TrimTolerance ....................................................................................................................... 2517
UpdateStiffness .................................................................................................................... 2517
UserOffset ............................................................................................................................ 2517
AddCommandSnippet() ........................................................................................................ 2517
AddComment() ..................................................................................................................... 2518
AddFigure() .......................................................................................................................... 2518
AddImage(string) .................................................................................................................. 2518
Delete() ................................................................................................................................ 2518
FlipContactTarget() ............................................................................................................... 2518
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2518
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2519
LoadContactRegionSettings(string) ....................................................................................... 2519
PromoteToNamedSelection() ................................................................................................ 2519
PromoteToRemotePoint() ...................................................................................................... 2520
ResetToDefault() ................................................................................................................... 2520
ResetToDefault(bool) ............................................................................................................ 2520
SaveContactRegionSettings(string) ....................................................................................... 2520
SearchConnectionsForDuplicatePairs() .................................................................................. 2520
ContactTool ................................................................................................................................ 2521
Children ............................................................................................................................... 2521
Comments ............................................................................................................................ 2522
DataModelObjectCategory ................................................................................................... 2522
Figures ................................................................................................................................. 2522
Images ................................................................................................................................. 2522
InternalObject ...................................................................................................................... 2522
Location ............................................................................................................................... 2522
ScopingMethod .................................................................................................................... 2523
AddComment() ..................................................................................................................... 2523
AddFigure() .......................................................................................................................... 2523
AddImage(string) .................................................................................................................. 2523
ClearGeneratedData() ........................................................................................................... 2523
Delete() ................................................................................................................................ 2523

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

GenerateInitialContactResults() ............................................................................................. 2524


GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2524
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2524
Joint ........................................................................................................................................... 2525
BushingWorksheet ................................................................................................................ 2527
Children ............................................................................................................................... 2527
Comments ............................................................................................................................ 2527
ConnectionType ................................................................................................................... 2527
CurveOrientationSurface ...................................................................................................... 2528
DataModelObjectCategory ................................................................................................... 2528
EffectiveLength ..................................................................................................................... 2528
ElementCoordinateSystem .................................................................................................... 2528
Figures ................................................................................................................................. 2528
Formulation .......................................................................................................................... 2528
FrictionCoefficient ................................................................................................................ 2529
Images ................................................................................................................................. 2529
InitialPosition ........................................................................................................................ 2529
InnerRadius .......................................................................................................................... 2529
InternalObject ...................................................................................................................... 2529
JointElementAPDLName ....................................................................................................... 2529
JointFrictionType .................................................................................................................. 2530
MobileAppliedBy .................................................................................................................. 2530
MobileBeamMaterial ............................................................................................................. 2530
MobileBeamRadius ............................................................................................................... 2530
MobileBehavior .................................................................................................................... 2530
MobileBody .......................................................................................................................... 2530
MobileCoordinateSystem ...................................................................................................... 2531
MobileLocation ..................................................................................................................... 2531
MobilePinballRegion ............................................................................................................. 2531
OuterRadius ......................................................................................................................... 2531
Radius .................................................................................................................................. 2531
ReferenceAppliedBy ............................................................................................................. 2531
ReferenceBeamMaterial ........................................................................................................ 2532
ReferenceBeamRadius .......................................................................................................... 2532
ReferenceBehavior ................................................................................................................ 2532
ReferenceBody ..................................................................................................................... 2532
ReferenceCoordinateSystem ................................................................................................. 2532
ReferenceLocation ................................................................................................................ 2532
ReferencePinballRegion ........................................................................................................ 2533
RestitutionFactor .................................................................................................................. 2533
Rotations .............................................................................................................................. 2533
RXMaximum ......................................................................................................................... 2533
RXMaximumType .................................................................................................................. 2533
RXMinimum ......................................................................................................................... 2533
RXMinimumType .................................................................................................................. 2534
RYMaximum ......................................................................................................................... 2534
RYMaximumType .................................................................................................................. 2534
RYMinimum .......................................................................................................................... 2534
RYMinimumType .................................................................................................................. 2534
RZMaximum ......................................................................................................................... 2534
RZMaximumType .................................................................................................................. 2535
RZMinimum .......................................................................................................................... 2535

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

RZMinimumType .................................................................................................................. 2535


ScrewPitch ............................................................................................................................ 2535
SolverElementType ............................................................................................................... 2535
Suppressed ........................................................................................................................... 2535
SuppressedForSolve ............................................................................................................. 2536
TorsionalDamping ................................................................................................................ 2536
TorsionalStiffness .................................................................................................................. 2536
TranslationX .......................................................................................................................... 2536
TranslationY .......................................................................................................................... 2536
TranslationZ .......................................................................................................................... 2536
Type ..................................................................................................................................... 2537
XMaximum ........................................................................................................................... 2537
XMaximumType .................................................................................................................... 2537
XMinimum ........................................................................................................................... 2537
XMinimumType .................................................................................................................... 2537
YMaximum ........................................................................................................................... 2537
YMaximumType .................................................................................................................... 2538
YMinimum ............................................................................................................................ 2538
YMinimumType .................................................................................................................... 2538
ZMaximum ........................................................................................................................... 2538
ZMaximumType .................................................................................................................... 2538
ZMinimum ............................................................................................................................ 2538
ZMinimumType .................................................................................................................... 2539
AddCommandSnippet() ........................................................................................................ 2539
AddComment() ..................................................................................................................... 2539
AddFigure() .......................................................................................................................... 2539
AddImage(string) .................................................................................................................. 2539
Delete() ................................................................................................................................ 2540
FlipReferenceMobile() ........................................................................................................... 2540
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2540
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2540
PromoteToNamedSelection() ................................................................................................ 2541
PromoteToRemotePoint() ...................................................................................................... 2541
Spring ........................................................................................................................................ 2541
Children ............................................................................................................................... 2543
Comments ............................................................................................................................ 2543
DataModelObjectCategory ................................................................................................... 2543
Figures ................................................................................................................................. 2543
FreeLength ........................................................................................................................... 2543
Images ................................................................................................................................. 2543
InternalObject ...................................................................................................................... 2544
Load ..................................................................................................................................... 2544
LongitudinalDamping ........................................................................................................... 2544
LongitudinalStiffness ............................................................................................................ 2544
Material ................................................................................................................................ 2544
MobileAppliedBy .................................................................................................................. 2544
MobileBeamMaterial ............................................................................................................. 2545
MobileBeamRadius ............................................................................................................... 2545
MobileBehavior .................................................................................................................... 2545
MobileBody .......................................................................................................................... 2545
MobileCoordinateSystem ...................................................................................................... 2545
MobileLocation ..................................................................................................................... 2545

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

MobilePinballRegion ............................................................................................................. 2546


MobileScopeLocation ........................................................................................................... 2546
MobileXCoordinate ............................................................................................................... 2546
MobileYCoordinate ............................................................................................................... 2546
MobileZCoordinate ............................................................................................................... 2546
NonLinearLongitudinalStiffness ............................................................................................ 2546
PreloadType ......................................................................................................................... 2547
ReferenceAppliedBy ............................................................................................................. 2547
ReferenceBeamMaterial ........................................................................................................ 2547
ReferenceBeamRadius .......................................................................................................... 2547
ReferenceBehavior ................................................................................................................ 2547
ReferenceBody ..................................................................................................................... 2547
ReferenceCoordinateSystem ................................................................................................. 2548
ReferenceLocation ................................................................................................................ 2548
ReferencePinballRegion ........................................................................................................ 2548
ReferenceScopeLocation ....................................................................................................... 2548
ReferenceXCoordinate .......................................................................................................... 2548
ReferenceYCoordinate .......................................................................................................... 2548
ReferenceZCoordinate .......................................................................................................... 2549
Scope ................................................................................................................................... 2549
SpringBehavior ..................................................................................................................... 2549
SpringElementAPDLName .................................................................................................... 2549
SpringLength ........................................................................................................................ 2549
SpringType ........................................................................................................................... 2549
Suppressed ........................................................................................................................... 2550
Visible .................................................................................................................................. 2550
AddComment() ..................................................................................................................... 2550
AddFigure() .......................................................................................................................... 2550
AddImage(string) .................................................................................................................. 2550
Delete() ................................................................................................................................ 2550
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2551
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2551
PromoteToNamedSelection() ................................................................................................ 2551
PromoteToRemotePoint() ...................................................................................................... 2552
Ansys.ACT.Automation.Mechanical.BoundaryConditions Namespace ......................................... 2553
Acceleration ............................................................................................................................... 2555
AbsoluteResult ..................................................................................................................... 2556
BaseExcitation ...................................................................................................................... 2557
BoundaryCondition .............................................................................................................. 2557
Children ............................................................................................................................... 2557
Comments ............................................................................................................................ 2557
CoordinateSystem ................................................................................................................ 2557
DataModelObjectCategory ................................................................................................... 2557
DefineBy ............................................................................................................................... 2558
Direction .............................................................................................................................. 2558
Figures ................................................................................................................................. 2558
HarmonicPhaseAngle ........................................................................................................... 2558
Images ................................................................................................................................. 2558
IndependentVariable ............................................................................................................ 2558
InternalObject ...................................................................................................................... 2559
Location ............................................................................................................................... 2559
Magnitude ............................................................................................................................ 2559

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

NumberOfSegments ............................................................................................................. 2559


PhaseAngle .......................................................................................................................... 2559
Suppressed ........................................................................................................................... 2559
XComponent ........................................................................................................................ 2560
YComponent ........................................................................................................................ 2560
ZComponent ........................................................................................................................ 2560
AddComment() ..................................................................................................................... 2560
AddFigure() .......................................................................................................................... 2560
AddImage(string) .................................................................................................................. 2560
Delete() ................................................................................................................................ 2561
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2561
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2561
AcousticAbsorptionElement ........................................................................................................ 2562
DataModelObjectCategory ................................................................................................... 2562
InternalObject ...................................................................................................................... 2562
Location ............................................................................................................................... 2563
AcousticAbsorptionSurface ......................................................................................................... 2563
AbsorptionCoefficient ........................................................................................................... 2564
DataModelObjectCategory ................................................................................................... 2564
InternalObject ...................................................................................................................... 2564
Location ............................................................................................................................... 2564
AcousticDiffuseSoundField ......................................................................................................... 2564
CoordinateSystem ................................................................................................................ 2565
DataModelObjectCategory ................................................................................................... 2566
FrequencyOfNormConvergenceCheck .................................................................................. 2566
InternalObject ...................................................................................................................... 2566
Location ............................................................................................................................... 2566
MassDensity ......................................................................................................................... 2566
Material ................................................................................................................................ 2566
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead ..................................... 2567
MaximumIncidentAngle ....................................................................................................... 2567
NormConvergenceTolerance ................................................................................................. 2567
NumberOfDivisionsOnReferenceSphere ................................................................................ 2567
NumberOfRandomSampling ................................................................................................. 2567
PressureExcitation ................................................................................................................. 2567
RadiusOfReferenceSphere ..................................................................................................... 2568
RadiusOfReferenceSphereDefineBy ....................................................................................... 2568
RandomSamplingType .......................................................................................................... 2568
ReferencePowerSpectralDensity ............................................................................................ 2568
SpeedOfSound ..................................................................................................................... 2568
AcousticFarFieldRadationSurface ................................................................................................ 2568
DataModelObjectCategory ................................................................................................... 2569
EquivalentSurfaceLocation .................................................................................................... 2569
InsideSurfaceBodiesLocation ................................................................................................ 2570
InternalObject ...................................................................................................................... 2570
AcousticFreeSurface ................................................................................................................... 2570
DataModelObjectCategory ................................................................................................... 2571
InternalObject ...................................................................................................................... 2571
Location ............................................................................................................................... 2571
AcousticImpedanceBoundary ..................................................................................................... 2571
DataModelObjectCategory ................................................................................................... 2572
Frequency ............................................................................................................................ 2572

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

InternalObject ...................................................................................................................... 2572


Location ............................................................................................................................... 2572
Reactance ............................................................................................................................. 2573
Resistance ............................................................................................................................ 2573
AcousticImpedanceSheet ........................................................................................................... 2573
DataModelObjectCategory ................................................................................................... 2574
InternalObject ...................................................................................................................... 2574
Location ............................................................................................................................... 2574
Reactance ............................................................................................................................. 2574
Resistance ............................................................................................................................ 2574
AcousticIncidentWaveSource ...................................................................................................... 2574
AnglePhi ............................................................................................................................... 2576
AngleTheta ........................................................................................................................... 2576
CalculateIncidentPower ........................................................................................................ 2576
DataModelObjectCategory ................................................................................................... 2576
DipoleLength ....................................................................................................................... 2576
ExcitationType ...................................................................................................................... 2577
IncidentWaveLocation .......................................................................................................... 2577
InternalObject ...................................................................................................................... 2577
MassDensity ......................................................................................................................... 2577
Material ................................................................................................................................ 2577
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead ..................................... 2577
PhaseAngle .......................................................................................................................... 2578
PortSelection ........................................................................................................................ 2578
PressureAmplitude ............................................................................................................... 2578
RadiusOfPulsatingSphere ...................................................................................................... 2578
SourceOriginX ...................................................................................................................... 2578
SourceOriginY ...................................................................................................................... 2578
SourceOriginZ ...................................................................................................................... 2579
SpeedOfSound ..................................................................................................................... 2579
VelocityAmplitude ................................................................................................................ 2579
WaveNumber ........................................................................................................................ 2579
WaveType ............................................................................................................................. 2579
XComponentOfUnitDipoleVector .......................................................................................... 2579
YComponentOfUnitDipoleVector .......................................................................................... 2580
ZComponentOfUnitDipoleVector .......................................................................................... 2580
AcousticLowReducedFrequency .................................................................................................. 2580
DataModelObjectCategory ................................................................................................... 2581
HeightOfRectangle ............................................................................................................... 2581
InternalObject ...................................................................................................................... 2581
LowReducedFrequencyModel ............................................................................................... 2581
RadiusOfCircle ...................................................................................................................... 2581
ThicknessOfLayer .................................................................................................................. 2582
WidthOfRectangle ................................................................................................................ 2582
AcousticMassSource ................................................................................................................... 2582
DataModelObjectCategory ................................................................................................... 2583
InternalObject ...................................................................................................................... 2583
Location ............................................................................................................................... 2583
Magnitude ............................................................................................................................ 2583
PhaseAngle .......................................................................................................................... 2583
AcousticPort ............................................................................................................................... 2584
DataModelObjectCategory ................................................................................................... 2584

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

InsideSurfaceBodiesLocation ................................................................................................ 2585


InternalObject ...................................................................................................................... 2585
PortBehavior ......................................................................................................................... 2585
PortNumber ......................................................................................................................... 2585
PortPosition .......................................................................................................................... 2585
PortSurfaceLocation ............................................................................................................. 2585
AcousticPortInDuct ..................................................................................................................... 2586
AnglePhi ............................................................................................................................... 2587
AngleTheta ........................................................................................................................... 2587
CoordinateSystem ................................................................................................................ 2587
DataModelObjectCategory ................................................................................................... 2587
Height .................................................................................................................................. 2588
InternalObject ...................................................................................................................... 2588
Location ............................................................................................................................... 2588
ModeIndexForPressureVariationAlongTheAzimuth ................................................................ 2588
ModeIndexForPressureVariationAlongTheHeigth .................................................................. 2588
ModeIndexForPressureVariationAlongTheRadii ..................................................................... 2588
ModeIndexForPressureVariationAlongTheWidth .................................................................... 2589
PhaseAngle .......................................................................................................................... 2589
PortAttribution ..................................................................................................................... 2589
PortSelection ........................................................................................................................ 2589
PressureAmplitude ............................................................................................................... 2589
Radius .................................................................................................................................. 2589
WaveType ............................................................................................................................. 2590
Width ................................................................................................................................... 2590
AcousticPressure ......................................................................................................................... 2590
DataModelObjectCategory ................................................................................................... 2591
InternalObject ...................................................................................................................... 2591
Location ............................................................................................................................... 2591
Magnitude ............................................................................................................................ 2591
AcousticRadiationBoundary ........................................................................................................ 2591
DataModelObjectCategory ................................................................................................... 2592
InternalObject ...................................................................................................................... 2592
Location ............................................................................................................................... 2592
AcousticRigidWall ....................................................................................................................... 2592
DataModelObjectCategory ................................................................................................... 2593
InternalObject ...................................................................................................................... 2593
Location ............................................................................................................................... 2593
AcousticStaticPressure ................................................................................................................ 2594
DataModelObjectCategory ................................................................................................... 2594
InternalObject ...................................................................................................................... 2595
Location ............................................................................................................................... 2595
Magnitude ............................................................................................................................ 2595
AcousticSurfaceVelocity .............................................................................................................. 2595
DataModelObjectCategory ................................................................................................... 2596
DefineBy ............................................................................................................................... 2596
InternalObject ...................................................................................................................... 2596
Location ............................................................................................................................... 2596
Magnitude ............................................................................................................................ 2597
PhaseAngle .......................................................................................................................... 2597
XComponent ........................................................................................................................ 2597
XPhaseAngle ........................................................................................................................ 2597

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

YComponent ........................................................................................................................ 2597


YPhaseAngle ........................................................................................................................ 2597
ZComponent ........................................................................................................................ 2598
ZPhaseAngle ........................................................................................................................ 2598
AcousticSymmetryPlane ............................................................................................................. 2598
CoordinateSystem ................................................................................................................ 2599
DataModelObjectCategory ................................................................................................... 2599
InternalObject ...................................................................................................................... 2599
Location ............................................................................................................................... 2599
AcousticTemperature .................................................................................................................. 2599
DataModelObjectCategory ................................................................................................... 2601
InternalObject ...................................................................................................................... 2601
AcousticThermoViscousBLIBoundary .......................................................................................... 2601
DataModelObjectCategory ................................................................................................... 2602
InternalObject ...................................................................................................................... 2602
Location ............................................................................................................................... 2602
AcousticTransferAdmittanceMatrix .............................................................................................. 2602
Alpha1Imag .......................................................................................................................... 2603
Alpha1Real ........................................................................................................................... 2604
Alpha2Imag .......................................................................................................................... 2604
Alpha2Real ........................................................................................................................... 2604
DataModelObjectCategory ................................................................................................... 2604
DynamicViscosity ................................................................................................................. 2604
GridPeriod ............................................................................................................................ 2604
HoleRadius ........................................................................................................................... 2605
InternalObject ...................................................................................................................... 2605
MassDensity ......................................................................................................................... 2605
Port1 .................................................................................................................................... 2605
Port2 .................................................................................................................................... 2605
RatioOfInnerAndOuterRadius ................................................................................................ 2605
StructureThickness ............................................................................................................... 2606
TransferAdmittanceModel ..................................................................................................... 2606
Y11Imag ............................................................................................................................... 2606
Y11Real ................................................................................................................................ 2606
Y12Imag ............................................................................................................................... 2606
Y12Real ................................................................................................................................ 2606
Y21Imag ............................................................................................................................... 2607
Y21Real ................................................................................................................................ 2607
Y22Imag ............................................................................................................................... 2607
Y22Real ................................................................................................................................ 2607
BearingLoad ............................................................................................................................... 2607
CoordinateSystem ................................................................................................................ 2608
DataModelObjectCategory ................................................................................................... 2608
DefineBy ............................................................................................................................... 2609
Direction .............................................................................................................................. 2609
InternalObject ...................................................................................................................... 2609
Location ............................................................................................................................... 2609
Magnitude ............................................................................................................................ 2609
XComponent ........................................................................................................................ 2609
YComponent ........................................................................................................................ 2610
ZComponent ........................................................................................................................ 2610
BodyControl ............................................................................................................................... 2610

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

ArtificialViscosityForShells ..................................................................................................... 2611


BeamSolutionType ................................................................................................................ 2611
BeamTimeStepSafetyFactor .................................................................................................. 2611
DataModelObjectCategory ................................................................................................... 2611
HexIntegrationType .............................................................................................................. 2612
HourglassDampingType ........................................................................................................ 2612
InternalObject ...................................................................................................................... 2612
Location ............................................................................................................................... 2612
PusoStabilityCoefficient ........................................................................................................ 2612
ShellBWCWarpCorrection ...................................................................................................... 2612
ShellInertiaUpdate ................................................................................................................ 2613
ShellShearCorrectionFactor ................................................................................................... 2613
ShellSublayers ...................................................................................................................... 2613
ShellThicknessUpdate ........................................................................................................... 2613
StiffnessCoefficient ............................................................................................................... 2613
TetIntegrationType ............................................................................................................... 2613
ViscousCoefficient ................................................................................................................ 2614
BoltPretension ............................................................................................................................ 2614
Children ............................................................................................................................... 2615
Comments ............................................................................................................................ 2615
CoordinateSystem ................................................................................................................ 2615
DataModelObjectCategory ................................................................................................... 2615
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. .................................................................. 2616
Figures ................................................................................................................................. 2616
Images ................................................................................................................................. 2616
Increment ............................................................................................................................. 2616
InternalObject ...................................................................................................................... 2616
Location ............................................................................................................................... 2616
Preadjustment ...................................................................................................................... 2617
Preload ................................................................................................................................. 2617
Suppressed ........................................................................................................................... 2617
AddComment() ..................................................................................................................... 2617
AddFigure() .......................................................................................................................... 2617
AddImage(string) .................................................................................................................. 2617
Delete() ................................................................................................................................ 2618
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2618
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2618
GetDefineBy(int) ................................................................................................................... 2619
PromoteToNamedSelection() ................................................................................................ 2619
SetDefineBy(int, BoltLoadDefineBy) ....................................................................................... 2619
CompressionOnlySupport ........................................................................................................... 2619
AutomaticNormalStiffness .................................................................................................... 2620
DataModelObjectCategory ................................................................................................... 2620
InternalObject ...................................................................................................................... 2621
Location ............................................................................................................................... 2621
NormalStiffnessFactor ........................................................................................................... 2621
UpdateStiffness .................................................................................................................... 2621
ConstraintEquation ..................................................................................................................... 2621
Children ............................................................................................................................... 2622
Comments ............................................................................................................................ 2622

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

DataModelObjectCategory ................................................................................................... 2622


Figures ................................................................................................................................. 2622
InternalObject ...................................................................................................................... 2622
Suppressed ........................................................................................................................... 2623
AddComment() ..................................................................................................................... 2623
AddFigure() .......................................................................................................................... 2623
Delete() ................................................................................................................................ 2623
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2623
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2624
ContactStepControl .................................................................................................................... 2624
ContactSelection .................................................................................................................. 2625
CurrentStep .......................................................................................................................... 2625
DataModelObjectCategory ................................................................................................... 2625
InternalObject ...................................................................................................................... 2625
NormalStiffness .................................................................................................................... 2625
NormalStiffnessFactor ........................................................................................................... 2626
NormalStiffnessValue ............................................................................................................ 2626
Status ................................................................................................................................... 2626
Convection ................................................................................................................................. 2626
AmbientTemperature ............................................................................................................ 2627
CoefficientType ..................................................................................................................... 2627
ConvectionMatrix ................................................................................................................. 2628
DataModelObjectCategory ................................................................................................... 2628
DisplayConnectionLines ........................................................................................................ 2628
EditDataFor .......................................................................................................................... 2628
FilmCoefficient ..................................................................................................................... 2628
FluidFlowEdge ***OBSOLETE*** Deprecated class. Use FluidFlowSelection instead. ................ 2628
FluidFlowSelection ............................................................................................................... 2629
GraphControlsXAxis .............................................................................................................. 2629
HasFluidFlow ........................................................................................................................ 2629
IndependentVariable ............................................................................................................ 2629
InternalObject ...................................................................................................................... 2629
Location ............................................................................................................................... 2629
NumberOfSegments ............................................................................................................. 2630
RangeMaximum ................................................................................................................... 2630
RangeMinimum .................................................................................................................... 2630
XYZFunctionCoordinateSystem ............................................................................................. 2630
CoupledPhysicsHeatingObjects ................................................................................................... 2630
Children ............................................................................................................................... 2631
Comments ............................................................................................................................ 2631
DataModelObjectCategory ................................................................................................... 2631
Images ................................................................................................................................. 2631
InternalObject ...................................................................................................................... 2632
Location ............................................................................................................................... 2632
Suppressed ........................................................................................................................... 2632
AddComment() ..................................................................................................................... 2632
AddImage(string) .................................................................................................................. 2632
Delete() ................................................................................................................................ 2632
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2633
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2633
Coupling .................................................................................................................................... 2633
Children ............................................................................................................................... 2634

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

Comments ............................................................................................................................ 2634


DataModelObjectCategory ................................................................................................... 2634
DOFSelection ....................................................................................................................... 2635
Images ................................................................................................................................. 2635
InternalObject ...................................................................................................................... 2635
LocalCoordinates .................................................................................................................. 2635
Location ............................................................................................................................... 2635
Suppressed ........................................................................................................................... 2635
AddComment() ..................................................................................................................... 2636
AddImage(string) .................................................................................................................. 2636
Delete() ................................................................................................................................ 2636
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2636
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2637
Current ....................................................................................................................................... 2637
DataModelObjectCategory ................................................................................................... 2638
InternalObject ...................................................................................................................... 2638
Location ............................................................................................................................... 2638
Magnitude ............................................................................................................................ 2638
NumberOfSegments ............................................................................................................. 2638
PhaseAngle .......................................................................................................................... 2639
CylindricalSupport ...................................................................................................................... 2639
Axial ..................................................................................................................................... 2640
DataModelObjectCategory ................................................................................................... 2640
InternalObject ...................................................................................................................... 2640
Location ............................................................................................................................... 2640
Radial ................................................................................................................................... 2640
Tangential ............................................................................................................................ 2640
DetonationPoint ......................................................................................................................... 2641
BurnInstantaneously ............................................................................................................. 2641
DataModelObjectCategory ................................................................................................... 2642
DetonationTime ................................................................................................................... 2642
InternalObject ...................................................................................................................... 2642
Location ............................................................................................................................... 2642
XCoordinate ......................................................................................................................... 2642
YCoordinate .......................................................................................................................... 2642
ZCoordinate ......................................................................................................................... 2643
Displacement ............................................................................................................................. 2643
AbsoluteResult ..................................................................................................................... 2644
BaseExcitation ...................................................................................................................... 2644
BoundaryCondition .............................................................................................................. 2644
CoordinateSystem ................................................................................................................ 2644
DataModelObjectCategory ................................................................................................... 2645
DefineBy ............................................................................................................................... 2645
Direction .............................................................................................................................. 2645
Distance ............................................................................................................................... 2645
GraphControlsXAxis .............................................................................................................. 2645
HarmonicPhaseAngle ........................................................................................................... 2645
IndependentVariable ............................................................................................................ 2646
InternalObject ...................................................................................................................... 2646
Location ............................................................................................................................... 2646
NumberOfSegments ............................................................................................................. 2646
PhaseAngle .......................................................................................................................... 2646

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

PhaseAngleX ........................................................................................................................ 2646


PhaseAngleY ........................................................................................................................ 2647
PhaseAngleZ ........................................................................................................................ 2647
RangeMaximum ................................................................................................................... 2647
RangeMinimum .................................................................................................................... 2647
XComponent ........................................................................................................................ 2647
XYZFunctionCoordinateSystem ............................................................................................. 2647
YComponent ........................................................................................................................ 2648
ZComponent ........................................................................................................................ 2648
EarthGravity ............................................................................................................................... 2648
Children ............................................................................................................................... 2649
Comments ............................................................................................................................ 2649
CoordinateSystem ................................................................................................................ 2649
DataModelObjectCategory ................................................................................................... 2649
Direction .............................................................................................................................. 2649
Figures ................................................................................................................................. 2650
GeometrySelection ............................................................................................................... 2650
Images ................................................................................................................................. 2650
InternalObject ...................................................................................................................... 2650
Suppressed ........................................................................................................................... 2650
XComponent ........................................................................................................................ 2650
YComponent ........................................................................................................................ 2651
ZComponent ........................................................................................................................ 2651
AddComment() ..................................................................................................................... 2651
AddFigure() .......................................................................................................................... 2651
AddImage(string) .................................................................................................................. 2651
Delete() ................................................................................................................................ 2652
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2652
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2652
ElasticSupport ............................................................................................................................ 2652
DataModelObjectCategory ................................................................................................... 2653
FoundationStiffness .............................................................................................................. 2653
InternalObject ...................................................................................................................... 2654
Location ............................................................................................................................... 2654
ElementBirthAndDeath ............................................................................................................... 2654
CurrentStep .......................................................................................................................... 2655
DataModelObjectCategory ................................................................................................... 2655
InternalObject ...................................................................................................................... 2655
Location ............................................................................................................................... 2655
Status ................................................................................................................................... 2655
ElementControls ......................................................................................................................... 2655
Children ............................................................................................................................... 2656
Comments ............................................................................................................................ 2656
DataModelObjectCategory ................................................................................................... 2656
Figures ................................................................................................................................. 2657
Images ................................................................................................................................. 2657
InternalObject ...................................................................................................................... 2657
Suppressed ........................................................................................................................... 2657
AddComment() ..................................................................................................................... 2657
AddFigure() .......................................................................................................................... 2657
AddImage(string) .................................................................................................................. 2658
Delete() ................................................................................................................................ 2658

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

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


GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2658
EMTransducer ............................................................................................................................. 2659
CoordinateSystem ................................................................................................................ 2660
DataModelObjectCategory ................................................................................................... 2660
GAPDirection ........................................................................................................................ 2660
IndependentVariable ............................................................................................................ 2660
InitialGap .............................................................................................................................. 2660
InternalObject ...................................................................................................................... 2661
Location ............................................................................................................................... 2661
MinimalGap .......................................................................................................................... 2661
NumberOfSegments ............................................................................................................. 2661
StiffnessMethod ................................................................................................................... 2661
VoltageDifference ................................................................................................................. 2661
ZCoordinate ......................................................................................................................... 2662
FixedRotation ............................................................................................................................. 2662
CoordinateSystem ................................................................................................................ 2663
DataModelObjectCategory ................................................................................................... 2663
InternalObject ...................................................................................................................... 2663
Location ............................................................................................................................... 2663
RotationX ............................................................................................................................. 2663
RotationY ............................................................................................................................. 2663
RotationZ ............................................................................................................................. 2664
FixedSupport .............................................................................................................................. 2664
DataModelObjectCategory ................................................................................................... 2665
InternalObject ...................................................................................................................... 2665
Location ............................................................................................................................... 2665
FluidSolidInterface ...................................................................................................................... 2665
DataModelObjectCategory ................................................................................................... 2666
ExportResults ....................................................................................................................... 2666
InterfaceNumber .................................................................................................................. 2666
InternalObject ...................................................................................................................... 2666
Location ............................................................................................................................... 2666
Force .......................................................................................................................................... 2667
AppliedBy ............................................................................................................................. 2668
CoordinateSystem ................................................................................................................ 2668
DataModelObjectCategory ................................................................................................... 2668
DefineBy ............................................................................................................................... 2668
Direction .............................................................................................................................. 2669
DivideLoadByNodes .............................................................................................................. 2669
GraphControlsXAxis .............................................................................................................. 2669
IndependentVariable ............................................................................................................ 2669
InternalObject ...................................................................................................................... 2669
Location ............................................................................................................................... 2669
Magnitude ............................................................................................................................ 2670
NumberOfSegments ............................................................................................................. 2670
PhaseAngle .......................................................................................................................... 2670
RangeMaximum ................................................................................................................... 2670
RangeMinimum .................................................................................................................... 2670
XComponent ........................................................................................................................ 2670
XComponentImag ................................................................................................................ 2671
XPhaseAngle ........................................................................................................................ 2671

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

YComponent ........................................................................................................................ 2671


YComponentImag ................................................................................................................ 2671
YPhaseAngle ........................................................................................................................ 2671
ZComponent ........................................................................................................................ 2671
ZComponentImag ................................................................................................................ 2672
ZPhaseAngle ........................................................................................................................ 2672
FrictionlessSupport ..................................................................................................................... 2672
DataModelObjectCategory ................................................................................................... 2673
InternalObject ...................................................................................................................... 2673
Location ............................................................................................................................... 2673
GeneralizedPlaneStrain ............................................................................................................... 2673
BoundaryConditionAlongFiber ............................................................................................. 2674
BoundaryConditionForRotationAboutX ................................................................................. 2674
BoundaryConditionForRotationAboutY ................................................................................. 2674
Children ............................................................................................................................... 2675
Comments ............................................................................................................................ 2675
CoordinateSystem ................................................................................................................ 2675
DataModelObjectCategory ................................................................................................... 2675
Figures ................................................................................................................................. 2675
Images ................................................................................................................................. 2675
InternalObject ...................................................................................................................... 2676
MagnitudeAlongFiber ........................................................................................................... 2676
MagnitudeRotationX ............................................................................................................ 2676
MagnitudeRotationY ............................................................................................................. 2676
Suppressed ........................................................................................................................... 2676
XCoordinateOfRefPoint ......................................................................................................... 2676
YCoordinateOfRefPoint ......................................................................................................... 2677
AddComment() ..................................................................................................................... 2677
AddFigure() .......................................................................................................................... 2677
AddImage(string) .................................................................................................................. 2677
Delete() ................................................................................................................................ 2677
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2677
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2678
GenericBoundaryCondition ........................................................................................................ 2678
Children ............................................................................................................................... 2679
Comments ............................................................................................................................ 2679
DataModelObjectCategory ................................................................................................... 2679
Figures ................................................................................................................................. 2679
Images ................................................................................................................................. 2680
InternalObject ...................................................................................................................... 2680
Suppressed ........................................................................................................................... 2680
AddComment() ..................................................................................................................... 2680
AddFigure() .......................................................................................................................... 2680
AddImage(string) .................................................................................................................. 2680
Delete() ................................................................................................................................ 2681
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2681
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2681
PromoteToNamedSelection() ................................................................................................ 2682
HeatFlow .................................................................................................................................... 2682
DataModelObjectCategory ................................................................................................... 2683
DefineAs ............................................................................................................................... 2683
InternalObject ...................................................................................................................... 2683

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

Location ............................................................................................................................... 2683


Magnitude ............................................................................................................................ 2683
NumberOfSegments ............................................................................................................. 2683
HeatFlux ..................................................................................................................................... 2684
DataModelObjectCategory ................................................................................................... 2684
InternalObject ...................................................................................................................... 2684
Location ............................................................................................................................... 2685
Magnitude ............................................................................................................................ 2685
NumberOfSegments ............................................................................................................. 2685
HydrostaticPressure .................................................................................................................... 2685
AppliedBy ............................................................................................................................. 2686
CoordinateSystem ................................................................................................................ 2686
DataModelObjectCategory ................................................................................................... 2686
DefineBy ............................................................................................................................... 2687
Direction .............................................................................................................................. 2687
FluidDensity ......................................................................................................................... 2687
InternalObject ...................................................................................................................... 2687
Location ............................................................................................................................... 2687
Magnitude ............................................................................................................................ 2687
ShellFace .............................................................................................................................. 2688
XComponent ........................................................................................................................ 2688
XCoordinate ......................................................................................................................... 2688
YComponent ........................................................................................................................ 2688
YCoordinate .......................................................................................................................... 2688
ZComponent ........................................................................................................................ 2688
ZCoordinate ......................................................................................................................... 2689
ImpedanceBoundary .................................................................................................................. 2689
DataModelObjectCategory ................................................................................................... 2690
InternalObject ...................................................................................................................... 2690
Location ............................................................................................................................... 2690
MaterialImpedance ............................................................................................................... 2690
ReferencePressure ................................................................................................................ 2690
ReferenceVelocity ................................................................................................................. 2690
InternalHeatGeneration .............................................................................................................. 2691
DataModelObjectCategory ................................................................................................... 2691
InternalObject ...................................................................................................................... 2692
Location ............................................................................................................................... 2692
Magnitude ............................................................................................................................ 2692
NumberOfSegments ............................................................................................................. 2692
JointLoad ................................................................................................................................... 2692
Children ............................................................................................................................... 2693
Comments ............................................................................................................................ 2693
DataModelObjectCategory ................................................................................................... 2693
DOF ...................................................................................................................................... 2693
Figures ................................................................................................................................. 2694
Images ................................................................................................................................. 2694
InternalObject ...................................................................................................................... 2694
Joint ..................................................................................................................................... 2694
JointConditionType .............................................................................................................. 2694
LockAtLoadStep .................................................................................................................... 2694
Magnitude ............................................................................................................................ 2695
Suppressed ........................................................................................................................... 2695

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

AddComment() ..................................................................................................................... 2695


AddFigure() .......................................................................................................................... 2695
AddImage(string) .................................................................................................................. 2695
Delete() ................................................................................................................................ 2696
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2696
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2696
LegacyThermalCondition ............................................................................................................ 2696
Children ............................................................................................................................... 2697
Comments ............................................................................................................................ 2697
DataModelObjectCategory ................................................................................................... 2697
Figures ................................................................................................................................. 2698
Images ................................................................................................................................. 2698
InternalObject ...................................................................................................................... 2698
AddComment() ..................................................................................................................... 2698
AddFigure() .......................................................................................................................... 2698
AddImage(string) .................................................................................................................. 2698
Delete() ................................................................................................................................ 2699
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2699
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2699
LinePressure ............................................................................................................................... 2700
CoordinateSystem ................................................................................................................ 2701
DataModelObjectCategory ................................................................................................... 2701
DefineBy ............................................................................................................................... 2701
Direction .............................................................................................................................. 2701
GraphControlsXAxis .............................................................................................................. 2701
IndependentVariable ............................................................................................................ 2701
InternalObject ...................................................................................................................... 2702
Location ............................................................................................................................... 2702
Magnitude ............................................................................................................................ 2702
NumberOfSegments ............................................................................................................. 2702
PhaseAngle .......................................................................................................................... 2702
RangeMaximum ................................................................................................................... 2702
RangeMinimum .................................................................................................................... 2703
XComponent ........................................................................................................................ 2703
XYZFunctionCoordinateSystem ............................................................................................. 2703
YComponent ........................................................................................................................ 2703
ZComponent ........................................................................................................................ 2703
LoadGroup ................................................................................................................................. 2703
Children ............................................................................................................................... 2704
Comments ............................................................................................................................ 2705
ConductingArea ................................................................................................................... 2705
ConductorCurrent ................................................................................................................. 2705
ConductorType ..................................................................................................................... 2705
DataModelObjectCategory ................................................................................................... 2705
Figures ................................................................................................................................. 2705
Images ................................................................................................................................. 2706
InternalObject ...................................................................................................................... 2706
Location ............................................................................................................................... 2706
NumberOfFrequenciesToConsider ......................................................................................... 2706
NumberOfTurns .................................................................................................................... 2706
PhaseAngle .......................................................................................................................... 2706
Suppressed ........................................................................................................................... 2707

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

AddComment() ..................................................................................................................... 2707


AddCurrent() ........................................................................................................................ 2707
AddFigure() .......................................................................................................................... 2707
AddImage(string) .................................................................................................................. 2707
AddVoltage() ........................................................................................................................ 2707
Delete() ................................................................................................................................ 2708
GenerateRemoteLoads() ....................................................................................................... 2708
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2708
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2708
MagneticFluxParallel ................................................................................................................... 2709
DataModelObjectCategory ................................................................................................... 2709
InternalObject ...................................................................................................................... 2710
Location ............................................................................................................................... 2710
MassFlowRate ............................................................................................................................. 2710
DataModelObjectCategory ................................................................................................... 2711
InternalObject ...................................................................................................................... 2711
Location ............................................................................................................................... 2711
Magnitude ............................................................................................................................ 2711
Moment ..................................................................................................................................... 2711
BeamMaterial ....................................................................................................................... 2713
BeamRadius .......................................................................................................................... 2713
Behavior ............................................................................................................................... 2713
CoordinateSystem ................................................................................................................ 2713
DataModelObjectCategory ................................................................................................... 2713
DefineBy ............................................................................................................................... 2713
HarmonicPhaseAngle ........................................................................................................... 2714
IndependentVariable ............................................................................................................ 2714
InternalObject ...................................................................................................................... 2714
LoadingApplicationType ....................................................................................................... 2714
Location ............................................................................................................................... 2714
Magnitude ............................................................................................................................ 2714
NumberOfSegments ............................................................................................................. 2715
PhaseAngle .......................................................................................................................... 2715
PhaseAngleX ........................................................................................................................ 2715
PhaseAngleY ........................................................................................................................ 2715
PhaseAngleZ ........................................................................................................................ 2715
PinballRegion ....................................................................................................................... 2715
RemotePoint ......................................................................................................................... 2716
RpmSelection ....................................................................................................................... 2716
RpmVarying .......................................................................................................................... 2716
XComponent ........................................................................................................................ 2716
YComponent ........................................................................................................................ 2716
ZComponent ........................................................................................................................ 2716
NodalDisplacement .................................................................................................................... 2717
CoordinateSystem ................................................................................................................ 2718
DataModelObjectCategory ................................................................................................... 2718
GraphControlsXAxis .............................................................................................................. 2718
IndependentVariable ............................................................................................................ 2718
InternalObject ...................................................................................................................... 2718
Location ............................................................................................................................... 2718
NumberOfSegments ............................................................................................................. 2719
PhaseAngle .......................................................................................................................... 2719

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

RangeMaximum ................................................................................................................... 2719


RangeMinimum .................................................................................................................... 2719
XComponent ........................................................................................................................ 2719
XYZFunctionCoordinateSystem ............................................................................................. 2719
YComponent ........................................................................................................................ 2720
ZComponent ........................................................................................................................ 2720
NodalForce ................................................................................................................................. 2720
CoordinateSystem ................................................................................................................ 2721
DataModelObjectCategory ................................................................................................... 2721
DivideLoadByNodes .............................................................................................................. 2721
GraphControlsXAxis .............................................................................................................. 2721
IndependentVariable ............................................................................................................ 2722
InternalObject ...................................................................................................................... 2722
Location ............................................................................................................................... 2722
NumberOfSegments ............................................................................................................. 2722
PhaseAngle .......................................................................................................................... 2722
RangeMaximum ................................................................................................................... 2722
RangeMinimum .................................................................................................................... 2723
XComponent ........................................................................................................................ 2723
XYZFunctionCoordinateSystem ............................................................................................. 2723
YComponent ........................................................................................................................ 2723
ZComponent ........................................................................................................................ 2723
NodalOrientation ........................................................................................................................ 2723
Children ............................................................................................................................... 2724
Comments ............................................................................................................................ 2724
CoordinateSystem ................................................................................................................ 2724
DataModelObjectCategory ................................................................................................... 2725
Images ................................................................................................................................. 2725
InternalObject ...................................................................................................................... 2725
Location ............................................................................................................................... 2725
Suppressed ........................................................................................................................... 2725
AddComment() ..................................................................................................................... 2725
AddImage(string) .................................................................................................................. 2726
Delete() ................................................................................................................................ 2726
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2726
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2726
NodalPressure ............................................................................................................................ 2727
DataModelObjectCategory ................................................................................................... 2728
DefineBy ............................................................................................................................... 2728
GraphControlsXAxis .............................................................................................................. 2728
IndependentVariable ............................................................................................................ 2728
InternalObject ...................................................................................................................... 2728
Location ............................................................................................................................... 2729
Magnitude ............................................................................................................................ 2729
NumberOfSegments ............................................................................................................. 2729
RangeMaximum ................................................................................................................... 2729
RangeMinimum .................................................................................................................... 2729
XYZFunctionCoordinateSystem ............................................................................................. 2729
NodalRotation ............................................................................................................................ 2730
CoordinateSystem ................................................................................................................ 2730
DataModelObjectCategory ................................................................................................... 2731
InternalObject ...................................................................................................................... 2731

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

Location ............................................................................................................................... 2731


RotationX ............................................................................................................................. 2731
RotationY ............................................................................................................................. 2731
RotationZ ............................................................................................................................. 2731
NonlinearAdaptiveRegion ........................................................................................................... 2732
CheckAt ................................................................................................................................ 2733
CheckAtValue ....................................................................................................................... 2733
Children ............................................................................................................................... 2733
Comments ............................................................................................................................ 2733
CoordinateSystem ................................................................................................................ 2733
Criterion ............................................................................................................................... 2734
DataModelObjectCategory ................................................................................................... 2734
EndTime ............................................................................................................................... 2734
EnergyCoefficient ................................................................................................................. 2734
Figures ................................................................................................................................. 2734
Images ................................................................................................................................. 2734
InternalObject ...................................................................................................................... 2735
JacobianRatioValue ............................................................................................................... 2735
LengthX ............................................................................................................................... 2735
LengthY ................................................................................................................................ 2735
LengthZ ................................................................................................................................ 2735
Location ............................................................................................................................... 2735
MaximumCornerAngle .......................................................................................................... 2736
Option .................................................................................................................................. 2736
SkewnessValue ..................................................................................................................... 2736
StartTime .............................................................................................................................. 2736
Suppressed ........................................................................................................................... 2736
TimeRange ........................................................................................................................... 2736
AddComment() ..................................................................................................................... 2737
AddFigure() .......................................................................................................................... 2737
AddImage(string) .................................................................................................................. 2737
Delete() ................................................................................................................................ 2737
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2737
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2738
PerfectlyInsulated ....................................................................................................................... 2738
DataModelObjectCategory ................................................................................................... 2739
DefineAs ............................................................................................................................... 2739
InternalObject ...................................................................................................................... 2739
Location ............................................................................................................................... 2739
Magnitude ............................................................................................................................ 2740
PipePressure ............................................................................................................................... 2740
DataModelObjectCategory ................................................................................................... 2741
GraphControlsXAxis .............................................................................................................. 2741
IndependentVariable ............................................................................................................ 2741
InternalObject ...................................................................................................................... 2741
Loading ................................................................................................................................ 2741
Location ............................................................................................................................... 2741
Magnitude ............................................................................................................................ 2742
NumberOfSegments ............................................................................................................. 2742
PhaseAngle .......................................................................................................................... 2742
RangeMaximum ................................................................................................................... 2742
RangeMinimum .................................................................................................................... 2742

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

XYZFunctionCoordinateSystem ............................................................................................. 2742


PipeTemperature ........................................................................................................................ 2743
DataModelObjectCategory ................................................................................................... 2744
GraphControlsXAxis .............................................................................................................. 2744
IndependentVariable ............................................................................................................ 2744
InternalObject ...................................................................................................................... 2744
Loading ................................................................................................................................ 2744
Location ............................................................................................................................... 2744
Magnitude ............................................................................................................................ 2745
NumberOfSegments ............................................................................................................. 2745
RangeMaximum ................................................................................................................... 2745
RangeMinimum .................................................................................................................... 2745
XYZFunctionCoordinateSystem ............................................................................................. 2745
PlasticHeating ............................................................................................................................. 2745
DataModelObjectCategory ................................................................................................... 2746
InternalObject ...................................................................................................................... 2746
PlasticWorkFraction .............................................................................................................. 2746
Pressure ...................................................................................................................................... 2747
AppliedBy ............................................................................................................................. 2748
CoordinateSystem ................................................................................................................ 2748
DataModelObjectCategory ................................................................................................... 2748
DefineBy ............................................................................................................................... 2748
Direction .............................................................................................................................. 2749
GraphControlsXAxis .............................................................................................................. 2749
IndependentVariable ............................................................................................................ 2749
InternalObject ...................................................................................................................... 2749
Location ............................................................................................................................... 2749
Magnitude ............................................................................................................................ 2749
MagnitudeImag .................................................................................................................... 2750
NumberOfSegments ............................................................................................................. 2750
PhaseAngle .......................................................................................................................... 2750
RangeMaximum ................................................................................................................... 2750
RangeMinimum .................................................................................................................... 2750
XComponent ........................................................................................................................ 2750
XComponentImag ................................................................................................................ 2751
XPhaseAngle ........................................................................................................................ 2751
XYZFunctionCoordinateSystem ............................................................................................. 2751
YComponent ........................................................................................................................ 2751
YComponentImag ................................................................................................................ 2751
YPhaseAngle ........................................................................................................................ 2751
ZComponent ........................................................................................................................ 2752
ZComponentImag ................................................................................................................ 2752
ZPhaseAngle ........................................................................................................................ 2752
PSDAcceleration ......................................................................................................................... 2752
DataModelObjectCategory ................................................................................................... 2753
InternalObject ...................................................................................................................... 2753
LoadData .............................................................................................................................. 2753
PSDDisplacement ....................................................................................................................... 2753
DataModelObjectCategory ................................................................................................... 2754
InternalObject ...................................................................................................................... 2754
LoadData .............................................................................................................................. 2754
PSDGAcceleration ....................................................................................................................... 2755

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

DataModelObjectCategory ................................................................................................... 2755


InternalObject ...................................................................................................................... 2755
LoadData .............................................................................................................................. 2756
PSDLoad ..................................................................................................................................... 2756
BoundaryCondition .............................................................................................................. 2756
Children ............................................................................................................................... 2757
Comments ............................................................................................................................ 2757
DataModelObjectCategory ................................................................................................... 2757
Direction .............................................................................................................................. 2757
Figures ................................................................................................................................. 2757
Images ................................................................................................................................. 2757
InternalObject ...................................................................................................................... 2758
Suppressed ........................................................................................................................... 2758
AddComment() ..................................................................................................................... 2758
AddFigure() .......................................................................................................................... 2758
AddImage(string) .................................................................................................................. 2758
Delete() ................................................................................................................................ 2759
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2759
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2759
PSDVelocity ................................................................................................................................ 2759
DataModelObjectCategory ................................................................................................... 2760
InternalObject ...................................................................................................................... 2760
LoadData .............................................................................................................................. 2761
Radiation .................................................................................................................................... 2761
AmbientTemperature ............................................................................................................ 2762
Correlation ........................................................................................................................... 2762
DataModelObjectCategory ................................................................................................... 2762
EditDataFor .......................................................................................................................... 2762
Emissivity ............................................................................................................................. 2762
Enclosure .............................................................................................................................. 2762
EnclosureType ...................................................................................................................... 2763
InternalObject ...................................................................................................................... 2763
Location ............................................................................................................................... 2763
NumberOfSegments ............................................................................................................. 2763
ShellFace .............................................................................................................................. 2763
RemoteDisplacement ................................................................................................................. 2763
BeamMaterial ....................................................................................................................... 2765
BeamRadius .......................................................................................................................... 2765
Behavior ............................................................................................................................... 2765
CoordinateSystem ................................................................................................................ 2765
DataModelObjectCategory ................................................................................................... 2765
InternalObject ...................................................................................................................... 2765
Location ............................................................................................................................... 2766
NumberOfSegments ............................................................................................................. 2766
PinballRegion ....................................................................................................................... 2766
RemotePoint ......................................................................................................................... 2766
RotationX ............................................................................................................................. 2766
RotationY ............................................................................................................................. 2766
RotationZ ............................................................................................................................. 2767
XComponent ........................................................................................................................ 2767
XCoordinate ......................................................................................................................... 2767
YComponent ........................................................................................................................ 2767

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

YCoordinate .......................................................................................................................... 2767


ZComponent ........................................................................................................................ 2767
ZCoordinate ......................................................................................................................... 2768
PromoteToRemotePoint() ...................................................................................................... 2768
RemoteForce .............................................................................................................................. 2768
BeamMaterial ....................................................................................................................... 2769
BeamRadius .......................................................................................................................... 2769
Behavior ............................................................................................................................... 2770
CoordinateSystem ................................................................................................................ 2770
DataModelObjectCategory ................................................................................................... 2770
DefineBy ............................................................................................................................... 2770
Direction .............................................................................................................................. 2770
FollowerLoad ........................................................................................................................ 2770
IndependentVariable ............................................................................................................ 2771
InternalObject ...................................................................................................................... 2771
LoadingApplicationType ....................................................................................................... 2771
Location ............................................................................................................................... 2771
Magnitude ............................................................................................................................ 2771
NumberOfSegments ............................................................................................................. 2771
PhaseAngle .......................................................................................................................... 2772
PinballRegion ....................................................................................................................... 2772
RpmSelection ....................................................................................................................... 2772
RpmVarying .......................................................................................................................... 2772
XComponent ........................................................................................................................ 2772
XCoordinate ......................................................................................................................... 2772
YComponent ........................................................................................................................ 2773
YCoordinate .......................................................................................................................... 2773
ZComponent ........................................................................................................................ 2773
ZCoordinate ......................................................................................................................... 2773
PromoteToRemotePoint() ...................................................................................................... 2773
RotatingForce ............................................................................................................................. 2773
AxisComponentX .................................................................................................................. 2775
AxisComponentY .................................................................................................................. 2775
AxisComponentZ .................................................................................................................. 2775
AxisLocationX ....................................................................................................................... 2775
AxisLocationY ....................................................................................................................... 2775
AxisLocationZ ....................................................................................................................... 2776
CalculatedFromUnbalancedMass .......................................................................................... 2776
CoordinateSystem ................................................................................................................ 2776
DataModelObjectCategory ................................................................................................... 2776
HitPointLocationX ................................................................................................................. 2776
HitPointLocationY ................................................................................................................. 2776
HitPointLocationZ ................................................................................................................. 2777
HitPointNodeId ..................................................................................................................... 2777
HitPointSelection .................................................................................................................. 2777
InternalObject ...................................................................................................................... 2777
Location ............................................................................................................................... 2777
Mass ..................................................................................................................................... 2777
PhaseAngle .......................................................................................................................... 2778
RotatingRadius ..................................................................................................................... 2778
SynchronousRatio ................................................................................................................. 2778
UnbalancedForceMagnitude ................................................................................................. 2778

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

XCoordinate ......................................................................................................................... 2778


YCoordinate .......................................................................................................................... 2778
ZCoordinate ......................................................................................................................... 2779
RotationalAcceleration ................................................................................................................ 2779
CoordinateSystem ................................................................................................................ 2780
DataModelObjectCategory ................................................................................................... 2780
DefineBy ............................................................................................................................... 2780
IndependentVariable ............................................................................................................ 2780
InternalObject ...................................................................................................................... 2780
Location ............................................................................................................................... 2781
Magnitude ............................................................................................................................ 2781
XComponent ........................................................................................................................ 2781
XCoordinate ......................................................................................................................... 2781
YComponent ........................................................................................................................ 2781
YCoordinate .......................................................................................................................... 2781
ZComponent ........................................................................................................................ 2782
ZCoordinate ......................................................................................................................... 2782
RotationalVelocity ....................................................................................................................... 2782
CoordinateSystem ................................................................................................................ 2783
DataModelObjectCategory ................................................................................................... 2783
DefineBy ............................................................................................................................... 2783
IndependentVariable ............................................................................................................ 2783
InternalObject ...................................................................................................................... 2784
Location ............................................................................................................................... 2784
Magnitude ............................................................................................................................ 2784
XComponent ........................................................................................................................ 2784
XCoordinate ......................................................................................................................... 2784
YComponent ........................................................................................................................ 2784
YCoordinate .......................................................................................................................... 2785
ZComponent ........................................................................................................................ 2785
ZCoordinate ......................................................................................................................... 2785
RotationBoundaryCondition ....................................................................................................... 2785
Children ............................................................................................................................... 2786
Comments ............................................................................................................................ 2786
DataModelObjectCategory ................................................................................................... 2786
Figures ................................................................................................................................. 2786
Images ................................................................................................................................. 2786
InternalObject ...................................................................................................................... 2787
NumberOfSegments ............................................................................................................. 2787
Suppressed ........................................................................................................................... 2787
AddComment() ..................................................................................................................... 2787
AddFigure() .......................................................................................................................... 2787
AddImage(string) .................................................................................................................. 2787
Delete() ................................................................................................................................ 2788
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2788
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2788
RSAcceleration ............................................................................................................................ 2789
DataModelObjectCategory ................................................................................................... 2790
InternalObject ...................................................................................................................... 2790
LoadData .............................................................................................................................. 2790
RSDisplacement .......................................................................................................................... 2790
DataModelObjectCategory ................................................................................................... 2792

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

InternalObject ...................................................................................................................... 2792


LoadData .............................................................................................................................. 2792
RSLoad ....................................................................................................................................... 2792
BoundaryCondition .............................................................................................................. 2793
Children ............................................................................................................................... 2793
Comments ............................................................................................................................ 2793
DataModelObjectCategory ................................................................................................... 2794
Direction .............................................................................................................................. 2794
Figures ................................................................................................................................. 2794
Images ................................................................................................................................. 2794
InternalObject ...................................................................................................................... 2794
MissingMassEffect ................................................................................................................ 2794
MissingMassEffectZPA ........................................................................................................... 2795
RigidResponseEffect ............................................................................................................. 2795
RigidResponseEffectFreqBegin .............................................................................................. 2795
RigidResponseEffectFreqEnd ................................................................................................. 2795
RigidResponseEffectType ...................................................................................................... 2795
RigidResponseEffectZPA ....................................................................................................... 2795
ScaleFactor ........................................................................................................................... 2796
Suppressed ........................................................................................................................... 2796
AddComment() ..................................................................................................................... 2796
AddFigure() .......................................................................................................................... 2796
AddImage(string) .................................................................................................................. 2796
Delete() ................................................................................................................................ 2797
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2797
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2797
RSVelocity ................................................................................................................................... 2797
DataModelObjectCategory ................................................................................................... 2799
InternalObject ...................................................................................................................... 2799
LoadData .............................................................................................................................. 2799
SimplySupported ........................................................................................................................ 2799
DataModelObjectCategory ................................................................................................... 2800
InternalObject ...................................................................................................................... 2800
Location ............................................................................................................................... 2800
Temperature ............................................................................................................................... 2800
ApplyToEntireBody ............................................................................................................... 2801
DataModelObjectCategory ................................................................................................... 2802
GraphControlsXAxis .............................................................................................................. 2802
IndependentVariable ............................................................................................................ 2802
InternalObject ...................................................................................................................... 2802
Location ............................................................................................................................... 2802
Magnitude ............................................................................................................................ 2802
NumberOfSegments ............................................................................................................. 2803
RangeMaximum ................................................................................................................... 2803
RangeMinimum .................................................................................................................... 2803
ShellFace .............................................................................................................................. 2803
XYZFunctionCoordinateSystem ............................................................................................. 2803
ThermalCondition ....................................................................................................................... 2803
DataModelObjectCategory ................................................................................................... 2804
GraphControlsXAxis .............................................................................................................. 2805
IndependentVariable ............................................................................................................ 2805
InternalObject ...................................................................................................................... 2805

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

Location ............................................................................................................................... 2805


Magnitude ............................................................................................................................ 2805
NumberOfSegments ............................................................................................................. 2805
RangeMaximum ................................................................................................................... 2806
RangeMinimum .................................................................................................................... 2806
ShellFace .............................................................................................................................. 2806
XYZFunctionCoordinateSystem ............................................................................................. 2806
Velocity ...................................................................................................................................... 2806
CoordinateSystem ................................................................................................................ 2807
DataModelObjectCategory ................................................................................................... 2807
DefineBy ............................................................................................................................... 2807
InternalObject ...................................................................................................................... 2808
Location ............................................................................................................................... 2808
NumberOfSegments ............................................................................................................. 2808
XComponent ........................................................................................................................ 2808
YComponent ........................................................................................................................ 2808
ZComponent ........................................................................................................................ 2808
ViscoelasticHeating ..................................................................................................................... 2809
DataModelObjectCategory ................................................................................................... 2809
InternalObject ...................................................................................................................... 2809
ViscoelasticLossFraction ........................................................................................................ 2810
Voltage ....................................................................................................................................... 2810
DataModelObjectCategory ................................................................................................... 2811
InternalObject ...................................................................................................................... 2811
Location ............................................................................................................................... 2811
Magnitude ............................................................................................................................ 2811
NumberOfSegments ............................................................................................................. 2811
PhaseAngle .......................................................................................................................... 2811
Ansys.ACT.Automation.Mechanical.AnalysisSettings Namespace ................................................ 2813
AnalysisSettings .......................................................................................................................... 2813
Children ............................................................................................................................... 2814
Comments ............................................................................................................................ 2814
DataModelObjectCategory ................................................................................................... 2814
Figures ................................................................................................................................. 2814
Graph ................................................................................................................................... 2814
Images ................................................................................................................................. 2814
InternalObject ...................................................................................................................... 2815
ScratchSolverFilesDirectory ................................................................................................... 2815
SolverFilesDirectory .............................................................................................................. 2815
AddComment() ..................................................................................................................... 2815
AddFigure() .......................................................................................................................... 2815
AddImage(string) .................................................................................................................. 2815
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2816
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2816
ANSYSAnalysisSettings ............................................................................................................... 2816
AggressiveRemeshing ........................................................................................................... 2828
AMCooldownNumberOfSubsteps ......................................................................................... 2828
AMPSConvergence ............................................................................................................... 2828
AMStepType ......................................................................................................................... 2828
AMSubstepsBetweenHeating ................................................................................................ 2829
AMSubstepsToApplyHeats .................................................................................................... 2829
AutomaticTimeStepping ....................................................................................................... 2829

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

AxisymmetryDivisions ........................................................................................................... 2829


BackStress ............................................................................................................................ 2829
BoundaryAngle .................................................................................................................... 2829
CacheResultsInMemory ........................................................................................................ 2830
CalculateAcceleration ........................................................................................................... 2830
CalculateEnergy .................................................................................................................... 2830
CalculateEulerAngles ............................................................................................................ 2830
CalculateReactions ................................................................................................................ 2830
CalculateThermalFlux ............................................................................................................ 2830
CalculateVelocity .................................................................................................................. 2831
CalculateVelocityAndAcceleration ......................................................................................... 2831
CalculateVolumeEnergy ........................................................................................................ 2831
CampbellDiagram ................................................................................................................. 2831
CarryOverTimeStep .............................................................................................................. 2831
CentralFrequency ................................................................................................................. 2831
ClusterNumber ..................................................................................................................... 2832
ClusterResults ....................................................................................................................... 2832
CombineRestartFiles ............................................................................................................. 2832
ConstantDamping ................................................................................................................ 2832
ConstantDampingRatio ........................................................................................................ 2832
ContactData ......................................................................................................................... 2832
ContactMiscellaneous ........................................................................................................... 2833
ContactSplit .......................................................................................................................... 2833
ContactSplitMaxNum ............................................................................................................ 2833
ContactSummary .................................................................................................................. 2833
CooldownTime ..................................................................................................................... 2833
CooldownTimeType .............................................................................................................. 2833
CoriolisEffect ........................................................................................................................ 2834
CreepEffects ......................................................................................................................... 2834
CSGConvergence .................................................................................................................. 2834
CStarIntegral ......................................................................................................................... 2834
CurrentConvergence ............................................................................................................. 2834
CurrentConvergenceMinimumReference ............................................................................... 2834
CurrentConvergenceTolerance .............................................................................................. 2835
CurrentConvergenceValue .................................................................................................... 2835
CurrentRestartPoint .............................................................................................................. 2835
CurrentRPMNumber ............................................................................................................. 2835
CurrentStepNumber ............................................................................................................. 2835
Damped ............................................................................................................................... 2835
DampingRatio ...................................................................................................................... 2836
DataModelObjectCategory ................................................................................................... 2836
DefineBy ............................................................................................................................... 2836
DeleteUnneededFiles ............................................................................................................ 2836
DisplacementConvergence ................................................................................................... 2836
DisplacementConvergenceMinimumReference ..................................................................... 2836
DisplacementConvergenceTolerance .................................................................................... 2837
DisplacementConvergenceValue ........................................................................................... 2837
EdgeSplittingAngle ............................................................................................................... 2837
ElectromagneticNodalForces ................................................................................................ 2837
ElementCurrentDensity ......................................................................................................... 2837
EmagAMPSConvergenceMinimumReference ......................................................................... 2837
EmagAMPSConvergenceTolerance ........................................................................................ 2838

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

EmagAMPSConvergenceValue .............................................................................................. 2838


EmagCSGConvergenceMinimumReference ........................................................................... 2838
EmagCSGConvergenceTolerance ........................................................................................... 2838
EmagCSGConvergenceValue ................................................................................................. 2838
EqvDampingRatioFromModal ............................................................................................... 2838
ExcludeInsignificantModes ................................................................................................... 2839
ExpandResultsFrom .............................................................................................................. 2839
Expansion ............................................................................................................................. 2839
FarFieldRadiationSurface ....................................................................................................... 2839
FluxConvergence .................................................................................................................. 2839
ForceConvergence ................................................................................................................ 2839
ForceConvergenceMinimumReference .................................................................................. 2840
ForceConvergenceTolerance ................................................................................................. 2840
ForceConvergenceValue ........................................................................................................ 2840
FractureSolverControls .......................................................................................................... 2840
Frequency ............................................................................................................................ 2840
FrequencySpacing ................................................................................................................ 2840
FutureAnalysis ...................................................................................................................... 2841
GeneralMiscellaneous ........................................................................................................... 2841
GeneralMiscellaneousOption ................................................................................................ 2841
GenerateMeshRestartPoints .................................................................................................. 2841
GenerateRestartPoints .......................................................................................................... 2841
GlobalSizeRatioQualityImprovement ..................................................................................... 2841
GlobalSizeRatioQualityRefinement ........................................................................................ 2842
HarmonicIndexInterval ......................................................................................................... 2842
HarmonicIndexRange ........................................................................................................... 2842
HeatConvergence ................................................................................................................. 2842
HeatConvergenceMinimumReference ................................................................................... 2842
HeatConvergenceTolerance .................................................................................................. 2842
HeatConvergenceValue ......................................................................................................... 2843
HeatGenerationRate ............................................................................................................. 2843
HemicubeResolution ............................................................................................................ 2843
IgnoreAcousticDamping ....................................................................................................... 2843
IncludeNegativeLoadMultiplier ............................................................................................. 2843
IncludeResidualVector .......................................................................................................... 2843
InertiaRelief .......................................................................................................................... 2844
InitialSubsteps ...................................................................................................................... 2844
InitialTimeStep ..................................................................................................................... 2844
InternalObject ...................................................................................................................... 2844
InverseOption ....................................................................................................................... 2844
InverseOptionEndStep .......................................................................................................... 2844
JIntegral ............................................................................................................................... 2845
KeepModalResults ................................................................................................................ 2845
KeepPreStressLoadPattern .................................................................................................... 2845
LargeDeflection .................................................................................................................... 2845
LayersToBuild ....................................................................................................................... 2845
LimitSearchToRange ............................................................................................................. 2845
LineSearch ............................................................................................................................ 2846
LoadStepValue ...................................................................................................................... 2846
MassCoefficient .................................................................................................................... 2846
MaterialForce ........................................................................................................................ 2846
MaximumHarmonicIndex ...................................................................................................... 2846

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

MaximumIteration ................................................................................................................ 2846


MaximumModesToFind ........................................................................................................ 2847
MaximumPointsToSavePerStep ............................................................................................. 2847
MaximumSubsteps ............................................................................................................... 2847
MaximumTimeStep .............................................................................................................. 2847
MeshLoadStepValue ............................................................................................................. 2847
MeshRetainFilesAfterFullSolve ............................................................................................... 2847
MeshSaveAtLoadStep ........................................................................................................... 2848
MeshSaveAtSubstep ............................................................................................................. 2848
MinimumHarmonicIndex ...................................................................................................... 2848
MinimumSubsteps ................................................................................................................ 2848
MinimumTimeStep ............................................................................................................... 2848
ModalFrequencyRange ......................................................................................................... 2848
ModalNumberOfPoints ......................................................................................................... 2849
ModalRangeMaximum .......................................................................................................... 2849
ModalRangeMinimum .......................................................................................................... 2849
ModeReuse .......................................................................................................................... 2849
ModesCombinationType ....................................................................................................... 2849
ModeSignificanceLevel ......................................................................................................... 2849
MomentConvergence ........................................................................................................... 2850
MomentConvergenceMinimumReference ............................................................................. 2850
MomentConvergenceTolerance ............................................................................................ 2850
MomentConvergenceValue ................................................................................................... 2850
MultipleRPMs ....................................................................................................................... 2850
NewtonRaphsonOption ........................................................................................................ 2850
NodalForces .......................................................................................................................... 2851
NonlinearData ...................................................................................................................... 2851
NonLinearFormulation .......................................................................................................... 2851
NonLinearSolution ................................................................................................................ 2851
NumberOfModesToUse ......................................................................................................... 2851
NumberOfRestartPoints ........................................................................................................ 2851
NumberOfRPMs .................................................................................................................... 2852
NumberOfSculptedLayersQualityImprovement ..................................................................... 2852
NumberOfSculptedLayersRefinement ................................................................................... 2852
NumberOfSteps .................................................................................................................... 2852
NumberOfSubSteps .............................................................................................................. 2852
NumberOfZones ................................................................................................................... 2852
NumericalDamping .............................................................................................................. 2853
NumericalDampingValue ...................................................................................................... 2853
OverRelaxation ..................................................................................................................... 2853
ParticipationFactor ................................................................................................................ 2853
RadiositySolver ..................................................................................................................... 2853
RangeMaximum ................................................................................................................... 2853
RangeMinimum .................................................................................................................... 2854
ReferenceTemperature .......................................................................................................... 2854
ReferenceTemperatureType .................................................................................................. 2854
RefinementAlgorithm ........................................................................................................... 2854
ReformulationTolerance ........................................................................................................ 2854
RelaxationTemperature ......................................................................................................... 2854
RelaxationTemperatureType ................................................................................................. 2855
RemeshingGradient .............................................................................................................. 2855
RemeshingToleranceQualityImprovement ............................................................................. 2855

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

RemeshingToleranceRefinement ........................................................................................... 2855


RestartAtLoadStep ................................................................................................................ 2855
RestartAtSubstep .................................................................................................................. 2855
RestartAtTime ....................................................................................................................... 2856
RestartType .......................................................................................................................... 2856
ResultFileCompression .......................................................................................................... 2856
RetainFilesAfterFullSolve ....................................................................................................... 2856
RetainModesymFileAfterSolve ............................................................................................... 2856
RotationConvergence ........................................................................................................... 2856
RotationConvergenceMinimumReference ............................................................................. 2857
RotationConvergenceTolerance ............................................................................................ 2857
RpmClusterNumber .............................................................................................................. 2857
RpmFrequencySpacing ......................................................................................................... 2857
RpmRangeMaximum ............................................................................................................ 2857
RpmRangeMinimum ............................................................................................................. 2857
RpmSolutionIntervals ........................................................................................................... 2858
RpmValue ............................................................................................................................. 2858
SaveAtLoadStep ................................................................................................................... 2858
SaveAtSubstep ..................................................................................................................... 2858
SaveMAPDLDB ...................................................................................................................... 2858
ScatteredFieldFormulation .................................................................................................... 2858
ScatteringOutputType .......................................................................................................... 2859
SearchRangeMaximum ......................................................................................................... 2859
SearchRangeMinimum .......................................................................................................... 2859
SIFS ...................................................................................................................................... 2859
SkipExpansion ...................................................................................................................... 2859
SolutionIntervals ................................................................................................................... 2859
SolutionMethod ................................................................................................................... 2860
SolverPivotChecking ............................................................................................................. 2860
SolverTolerance .................................................................................................................... 2860
SolverType ............................................................................................................................ 2860
SolverUnits ........................................................................................................................... 2860
SolverUnitSystem ................................................................................................................. 2860
SpectrumType ...................................................................................................................... 2861
SpinSoftening ....................................................................................................................... 2861
SpringStiffness ...................................................................................................................... 2861
SpringStiffnessFactor ............................................................................................................ 2861
SpringStiffnessValue ............................................................................................................. 2861
Stabilization .......................................................................................................................... 2861
StabilizationActivationForFirstSubstep .................................................................................. 2862
StabilizationDampingFactor .................................................................................................. 2862
StabilizationEnergyDissipationRatio ...................................................................................... 2862
StabilizationForceLimit .......................................................................................................... 2862
StabilizationMethod ............................................................................................................. 2862
StepEndTime ........................................................................................................................ 2862
StepName ............................................................................................................................ 2863
StiffnessCoefficient ............................................................................................................... 2863
StiffnessCoefficientDefineBy ................................................................................................. 2863
StoreComplexSolution .......................................................................................................... 2863
StoreModalResults ................................................................................................................ 2863
StoreResulsAtValue ............................................................................................................... 2863
StoreResultsAt ...................................................................................................................... 2864

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

StoreResultsAtAllFrequencies ................................................................................................ 2864


Strain .................................................................................................................................... 2864
Stress ................................................................................................................................... 2864
StructuralDampingCoefficient ............................................................................................... 2864
StructuralOnly ...................................................................................................................... 2864
SurfaceStress ........................................................................................................................ 2865
TemperatureConvergence ..................................................................................................... 2865
TemperatureConvergenceInputValue .................................................................................... 2865
TemperatureConvergenceMinimumReference ....................................................................... 2865
TemperatureConvergenceTolerance ...................................................................................... 2865
TemperatureConvergenceValue ............................................................................................ 2865
ThermalOnly ......................................................................................................................... 2866
TimeIntegration .................................................................................................................... 2866
TimeStep .............................................................................................................................. 2866
TransientApplication ............................................................................................................. 2866
TransientApplicationUserDefined .......................................................................................... 2866
TStress .................................................................................................................................. 2866
VariationalTechnology .......................................................................................................... 2867
ViewFactorMethod ............................................................................................................... 2867
VoltageConvergence ............................................................................................................. 2867
VoltageConvergenceMinimumReference ............................................................................... 2867
VoltageConvergenceTolerance .............................................................................................. 2867
VoltageConvergenceValue .................................................................................................... 2867
WeakSprings ......................................................................................................................... 2868
GetAMStepType(uint) ........................................................................................................... 2868
GetAutomaticTimeStepping(uint) ......................................................................................... 2868
GetCarryOverTimeStep(uint) ................................................................................................. 2868
GetDefineBy(uint) ................................................................................................................. 2869
GetDisplacementConvergenceMinimumReference(uint) ....................................................... 2869
GetDisplacementConvergenceTolerance(uint) ....................................................................... 2869
GetDisplacementConvergenceType(uint) .............................................................................. 2869
GetDisplacementConvergenceValue(uint) ............................................................................. 2870
GetForceConvergenceMinimumReference(uint) .................................................................... 2870
GetForceConvergenceTolerance(uint) .................................................................................... 2870
GetForceConvergenceType(uint) ........................................................................................... 2870
GetForceConvergenceValue(uint) .......................................................................................... 2871
GetInitialSubsteps(uint) ........................................................................................................ 2871
GetInitialTimeStep(uint) ........................................................................................................ 2871
GetLineSearch(uint) .............................................................................................................. 2872
GetMaximumSubsteps(uint) ................................................................................................. 2872
GetMaximumTimeStep(uint) ................................................................................................. 2872
GetMinimumSubsteps(uint) .................................................................................................. 2872
GetMinimumTimeStep(uint) ................................................................................................. 2873
GetMomentConvergenceMinimumReference(uint) ............................................................... 2873
GetMomentConvergenceTolerance(uint) ............................................................................... 2873
GetMomentConvergenceType(uint) ...................................................................................... 2873
GetMomentConvergenceValue(uint) ..................................................................................... 2874
GetRotationConvergenceMinimumReference(uint) ............................................................... 2874
GetRotationConvergenceTolerance(uint) ............................................................................... 2874
GetRotationConvergenceType(uint) ...................................................................................... 2875
GetRotationConvergenceValue(uint) ..................................................................................... 2875
GetStabilization(uint) ............................................................................................................ 2875

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

GetStabilizationDampingFactor(uint) .................................................................................... 2875


GetStabilizationEnergyDissipationRatio(uint) ........................................................................ 2876
GetStabilizationFirstSubstepOption(uint) .............................................................................. 2876
GetStabilizationForceLimit(uint) ............................................................................................ 2876
GetStabilizationMethod(uint) ................................................................................................ 2876
GetStepEndTime(uint) .......................................................................................................... 2877
GetStepName(uint) ............................................................................................................... 2877
GetStoreResulsAtValue(uint) ................................................................................................. 2877
GetStoreResultsAt(uint) ......................................................................................................... 2878
SetAutomaticTimeStepping(uint, AutomaticTimeStepping) ................................................... 2878
SetCarryOverTimeStep(uint, bool) ......................................................................................... 2878
SetDefineBy(uint, TimeStepDefineByType) ............................................................................. 2878
SetDisplacementConvergenceMinimumReference(uint, Quantity) ......................................... 2879
SetDisplacementConvergenceTolerance(uint, double) ........................................................... 2879
SetDisplacementConvergenceType(uint, ConvergenceToleranceType) ................................... 2879
SetDisplacementConvergenceValue(uint, Quantity) ............................................................... 2880
SetForceConvergenceMinimumReference(uint, Quantity) ...................................................... 2880
SetForceConvergenceTolerance(uint, double) ........................................................................ 2880
SetForceConvergenceType(uint, ConvergenceToleranceType) ................................................ 2881
SetForceConvergenceValue(uint, Quantity) ............................................................................ 2881
SetInitialSubsteps(uint, uint) .................................................................................................. 2881
SetInitialTimeStep(uint, Quantity) .......................................................................................... 2882
SetLineSearch(uint, LineSearchType) ..................................................................................... 2882
SetMaximumSubsteps(uint, uint) ........................................................................................... 2882
SetMaximumTimeStep(uint, Quantity) ................................................................................... 2883
SetMinimumSubsteps(uint, uint) ........................................................................................... 2883
SetMinimumTimeStep(uint, Quantity) ................................................................................... 2883
SetMomentConvergenceMinimumReference(uint, Quantity) ................................................. 2884
SetMomentConvergenceTolerance(uint, double) ................................................................... 2884
SetMomentConvergenceType(uint, ConvergenceToleranceType) ........................................... 2884
SetMomentConvergenceValue(uint, Quantity) ....................................................................... 2885
SetRotationConvergenceMinimumReference(uint, Quantity) ................................................. 2885
SetRotationConvergenceTolerance(uint, double) ................................................................... 2885
SetRotationConvergenceType(uint, ConvergenceToleranceType) ........................................... 2886
SetRotationConvergenceValue(uint, Quantity) ....................................................................... 2886
SetStabilization(uint, StabilizationType) ................................................................................. 2886
SetStabilizationDampingFactor(uint, double) ......................................................................... 2887
SetStabilizationEnergyDissipationRatio(uint, double) ............................................................. 2887
SetStabilizationFirstSubstepOption(uint, StabilizationFirstSubstepOption) ............................. 2887
SetStabilizationForceLimit(uint, double) ................................................................................ 2888
SetStabilizationMethod(uint, StabilizationMethod) ................................................................ 2888
SetStepEndTime(uint, Quantity) ............................................................................................ 2888
SetStepName(uint, string) ..................................................................................................... 2889
SetStoreResulsAtValue(uint, uint) ........................................................................................... 2889
SetStoreResultsAt(uint, TimePointsOptions) ........................................................................... 2889
EXDAnalysisSettings ................................................................................................................... 2890
ArtificialViscosityForShellsType ............................................................................................. 2894
AutomaticMassScalingType .................................................................................................. 2894
BeamSolutionType ................................................................................................................ 2895
BeamTimeStepSafetyFactor .................................................................................................. 2895
CharZoneDimensionType ...................................................................................................... 2895
CurrentStepNumber ............................................................................................................. 2895

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

DensityUpdateType .............................................................................................................. 2895


ErosionGeomStrainLimit ....................................................................................................... 2895
ErosionMinElemTimestep ..................................................................................................... 2896
ErosionOnGeomStrainType ................................................................................................... 2896
ErosionOnMaterialFailureType ............................................................................................... 2896
ErosionOnMinElemTimestepType .......................................................................................... 2896
ErosionRetainIntertiaType ..................................................................................................... 2896
EulerBoundLowerX ............................................................................................................... 2896
EulerBoundLowerY ............................................................................................................... 2897
EulerBoundLowerZ ............................................................................................................... 2897
EulerBoundUpperX ............................................................................................................... 2897
EulerBoundUpperY ............................................................................................................... 2897
EulerBoundUpperZ ............................................................................................................... 2897
EulerCellSize ......................................................................................................................... 2897
EulerDisplayBox .................................................................................................................... 2898
EulerDomScopeDefType ....................................................................................................... 2898
EulerPropertyDisplayBox ....................................................................................................... 2898
EulerPropertyXmin ............................................................................................................... 2898
EulerPropertyXres ................................................................................................................. 2898
EulerPropertyXsize ................................................................................................................ 2898
EulerPropertyYmin ................................................................................................................ 2899
EulerPropertyYres ................................................................................................................. 2899
EulerPropertyYsize ................................................................................................................ 2899
EulerPropertyZmin ............................................................................................................... 2899
EulerPropertyZres ................................................................................................................. 2899
EulerPropertyZsize ................................................................................................................ 2899
EulerResolutionDefType ........................................................................................................ 2900
EulerSizeDefType .................................................................................................................. 2900
EulerTotalCells ...................................................................................................................... 2900
EulerTrackType ..................................................................................................................... 2900
EulerXDim ............................................................................................................................ 2900
EulerXOrigin ......................................................................................................................... 2900
EulerXScaleFactor ................................................................................................................. 2901
EulerXZones ......................................................................................................................... 2901
EulerYDim ............................................................................................................................ 2901
EulerYOrigin ......................................................................................................................... 2901
EulerYScaleFactor ................................................................................................................. 2901
EulerYZones ......................................................................................................................... 2901
EulerZDim ............................................................................................................................ 2902
EulerZOrigin ......................................................................................................................... 2902
EulerZScaleFactor ................................................................................................................. 2902
EulerZZones ......................................................................................................................... 2902
HexIntegrationType .............................................................................................................. 2902
HourglassDampingType ........................................................................................................ 2902
InitialTimeStep ..................................................................................................................... 2903
InternalObject ...................................................................................................................... 2903
LinearArtificialViscosity ......................................................................................................... 2903
LinearViscosityExpansionType ............................................................................................... 2903
MassScalingMaxElem ............................................................................................................ 2903
MassScalingMaxPart ............................................................................................................. 2903
MassScalingMinTimeStep ..................................................................................................... 2904
MassScalingUpdateFreq ........................................................................................................ 2904

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

MaximumEnergyError ........................................................................................................... 2904


MaximumTimeStep .............................................................................................................. 2904
MaximumTimeSteps ............................................................................................................. 2904
MaximumVelocity ................................................................................................................. 2904
MinimumStrainCutOff ........................................................................................................... 2905
MinimumTimeStep ............................................................................................................... 2905
MinimumVelocity ................................................................................................................. 2905
NumberOfSteps .................................................................................................................... 2905
OutputContactForcesOnPoints .............................................................................................. 2905
OutputContactForcesOnTime ............................................................................................... 2905
OutputContactForcesOnTimeSteps ....................................................................................... 2906
OutputContactForcesOnType ................................................................................................ 2906
PreferenceType ..................................................................................................................... 2906
PusoCoefficient ..................................................................................................................... 2906
QuadraticArtificialViscosity ................................................................................................... 2906
RadiusCutoff ......................................................................................................................... 2906
ReferenceEnergyTimeStep .................................................................................................... 2907
ResumeFromTimeStep .......................................................................................................... 2907
SavePrintSummaryOnTime ................................................................................................... 2907
SavePrintSummaryOnTimeSteps ........................................................................................... 2907
SavePrintSummaryOnType .................................................................................................... 2907
SaveUserEditOnTime ............................................................................................................ 2907
SaveUserEditOnTimeSteps .................................................................................................... 2908
SaveUserEditOnType ............................................................................................................. 2908
ShellInertiaUpdateType ......................................................................................................... 2908
ShellShearCorrectionFactor ................................................................................................... 2908
ShellSublayers ...................................................................................................................... 2908
ShellThicknessUpdateType .................................................................................................... 2908
ShellWarpCorrection ............................................................................................................. 2909
SolverPrecisionType .............................................................................................................. 2909
SolveUnits ............................................................................................................................ 2909
StepawareOutputControlsType ............................................................................................. 2909
StiffnessCoefficient ............................................................................................................... 2909
TetPressureIntegrationType ................................................................................................... 2909
TimeStepSafetyFactor ........................................................................................................... 2910
ViscousCoefficient ................................................................................................................ 2910
ViscousCoefficientFB ............................................................................................................. 2910
GetLoadStepType(int) ........................................................................................................... 2910
GetSaveProbeDataOnTime(int) ............................................................................................. 2910
GetSaveProbeDataOnTimeSteps(int) ..................................................................................... 2911
GetSaveProbeDataOnType(int) .............................................................................................. 2911
GetSaveRestartsOnPoints(int) ................................................................................................ 2911
GetSaveRestartsOnTime(int) ................................................................................................. 2911
GetSaveRestartsOnTimeSteps(int) ......................................................................................... 2912
GetSaveRestartsOnType(int) .................................................................................................. 2912
GetSaveResultsOnPoints(int) ................................................................................................. 2912
GetSaveResultsOnTime(int) ................................................................................................... 2913
GetSaveResultsOnTimeSteps(int) .......................................................................................... 2913
GetSaveResultsOnType(int) ................................................................................................... 2913
GetStaticDamping(int) .......................................................................................................... 2913
GetStepEndTime(int) ............................................................................................................ 2914
SetLoadStepType(int, EXDLoadStepType) .............................................................................. 2914

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

SetSaveProbeDataOnTime(int, Quantity) ............................................................................... 2914


SetSaveProbeDataOnTimeSteps(int, int) ................................................................................ 2915
SetSaveProbeDataOnType(int, EXDSaveProbeDataOnType) ................................................... 2915
SetSaveRestartsOnPoints(int, int) ........................................................................................... 2915
SetSaveRestartsOnTime(int, Quantity) ................................................................................... 2916
SetSaveRestartsOnTimeSteps(int, int) .................................................................................... 2916
SetSaveRestartsOnType(int, EXDSaveRestartsOnType) ........................................................... 2916
SetSaveResultsOnPoints(int, int) ............................................................................................ 2917
SetSaveResultsOnTime(int, Quantity) ..................................................................................... 2917
SetSaveResultsOnTimeSteps(int, int) ...................................................................................... 2917
SetSaveResultsOnType(int, EXDSaveResultsOnType) .............................................................. 2918
SetStaticDamping(int, double) .............................................................................................. 2918
SetStepEndTime(int, Quantity) .............................................................................................. 2918
RBDAnalysisSettings ................................................................................................................... 2919
AssemblyType ...................................................................................................................... 2921
ConstraintEquationResidualTolerance ................................................................................... 2921
ConstraintEquationResidualToleranceValue ........................................................................... 2921
CorrectionType ..................................................................................................................... 2921
CurrentStepNumber ............................................................................................................. 2921
DropoffTolerance .................................................................................................................. 2922
EnergyAccuracyTolerance ..................................................................................................... 2922
EnergyAccuracyToleranceValue ............................................................................................. 2922
ForceResidualTolerance ......................................................................................................... 2922
ForceResidualToleranceValue ................................................................................................ 2922
InternalObject ...................................................................................................................... 2922
NumberOfSteps .................................................................................................................... 2923
NumericalDampingTolerance ................................................................................................ 2923
NumericalDampingValue ...................................................................................................... 2923
PerformStaticAnalysis ........................................................................................................... 2923
PositionCorrection ................................................................................................................ 2923
RelativeAssemblyTolerance ................................................................................................... 2923
RelativeAssemblyToleranceValue ........................................................................................... 2924
TimeIntegrationType ............................................................................................................ 2924
VelocityCorrection ................................................................................................................ 2924
GetAutomaticTimeStepping(int) ........................................................................................... 2924
GetCarryOverTimeStep(int) ................................................................................................... 2924
GetInitialTimeStep(int) .......................................................................................................... 2925
GetMaximumTimeStep(int) ................................................................................................... 2925
GetMinimumTimeStep(int) ................................................................................................... 2925
GetStepEndTime(int) ............................................................................................................ 2925
GetStoreResultAt(int) ............................................................................................................ 2926
GetStoreResultAtValue(int) .................................................................................................... 2926
GetTimeStep(int) .................................................................................................................. 2926
SetAutomaticTimeStepping(int, AutomaticTimeStepping) ..................................................... 2927
SetCarryOverTimeStep(int, bool) ........................................................................................... 2927
SetInitialTimeStep(int, Quantity) ............................................................................................ 2927
SetMaximumTimeStep(int, Quantity) ..................................................................................... 2928
SetMinimumTimeStep(int, Quantity) ..................................................................................... 2928
SetStepEndTime(int, Quantity) .............................................................................................. 2928
SetStoreResultAt(int, TimePointsOptions) .............................................................................. 2929
SetStoreResultAtValue(int, int) ............................................................................................... 2929
SetTimeStep(int, Quantity) .................................................................................................... 2929

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

TopoOptAnalysisSettings ............................................................................................................ 2930


ConvergenceAccuracy .......................................................................................................... 2931
DataModelObjectCategory ................................................................................................... 2931
DeleteUnneededFiles ............................................................................................................ 2931
Filter ..................................................................................................................................... 2931
FutureAnalysis ...................................................................................................................... 2931
InternalObject ...................................................................................................................... 2932
MaximumNumberOfIterations .............................................................................................. 2932
MaxNumOfIntermediateFiles ................................................................................................ 2932
MinimumNormalizedDensity ................................................................................................ 2932
OptimizationOutputLog ........................................................................................................ 2932
PenaltyFactor ........................................................................................................................ 2932
RegionOfAMOverhangConstraint .......................................................................................... 2933
RegionOfManufacturingConstraint ....................................................................................... 2933
RegionOfMinMemberSize ..................................................................................................... 2933
SaveMAPDLDB ...................................................................................................................... 2933
SolverType ............................................................................................................................ 2933
SolverUnits ........................................................................................................................... 2933
SolverUnitSystem ................................................................................................................. 2934
StoreResultsAt ...................................................................................................................... 2934
StoreResultsAtValue .............................................................................................................. 2934
Ansys.ACT.Automation.Mechanical.AdditiveManufacturing Namespace ..................................... 2935
AMBuildSettings ......................................................................................................................... 2935
AdditiveProcess .................................................................................................................... 2937
BuildGasConvectionCoefficient ............................................................................................. 2937
BuildGasOrPowderTemperatureType ..................................................................................... 2937
BuildGasTemperature ........................................................................................................... 2938
BuildPowderConvectionCoefficient ....................................................................................... 2938
BuildPowderTemperature ..................................................................................................... 2938
Children ............................................................................................................................... 2938
Comments ............................................................................................................................ 2938
CooldownGasConvectionCoefficient ..................................................................................... 2938
CooldownGasOrPowderTemperatureType ............................................................................. 2939
CooldownGasTemperature ................................................................................................... 2939
CooldownPowderConvectionCoefficient ............................................................................... 2939
CooldownPowderTemperature ............................................................................................. 2939
DataModelObjectCategory ................................................................................................... 2939
DepositionThickness ............................................................................................................. 2939
DwellTime ............................................................................................................................ 2940
DwellTimeMultiple ............................................................................................................... 2940
Figures ................................................................................................................................. 2940
HatchSpacing ....................................................................................................................... 2940
Images ................................................................................................................................. 2940
InherentStrain ....................................................................................................................... 2940
InherentStrainDefinition ....................................................................................................... 2941
InternalObject ...................................................................................................................... 2941
LayerHeightType ................................................................................................................... 2941
LayerHeightValue ................................................................................................................. 2941
NumberOfHeatSources ......................................................................................................... 2941
PowderPropertyFactor .......................................................................................................... 2941
PreheatTemperature ............................................................................................................. 2942
RoomTemperature ................................................................................................................ 2942

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

ScanSpeed ............................................................................................................................ 2942


StrainScalingFactor ............................................................................................................... 2942
StrainScalingFactorX ............................................................................................................. 2942
StrainScalingFactorY ............................................................................................................. 2942
StrainScalingFactorZ ............................................................................................................. 2943
AddComment() ..................................................................................................................... 2943
AddFigure() .......................................................................................................................... 2943
AddImage(string) .................................................................................................................. 2943
Delete() ................................................................................................................................ 2943
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2944
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2944
LoadBuildSettings(string) ...................................................................................................... 2944
ResetToDefault() ................................................................................................................... 2945
SaveBuildSettings(string) ...................................................................................................... 2945
AMProcess .................................................................................................................................. 2945
BaseGeometry ...................................................................................................................... 2946
BuildGeometry ..................................................................................................................... 2946
Children ............................................................................................................................... 2946
Comments ............................................................................................................................ 2947
DataModelObjectCategory ................................................................................................... 2947
ElementSize .......................................................................................................................... 2947
Figures ................................................................................................................................. 2947
Images ................................................................................................................................. 2947
InternalObject ...................................................................................................................... 2947
LengthUnits .......................................................................................................................... 2948
MeshUsingVoxelization ......................................................................................................... 2948
NonlinearEffects ................................................................................................................... 2948
SubsampleRate ..................................................................................................................... 2948
WallThickness ....................................................................................................................... 2948
ZLocationAtTopOfBase ......................................................................................................... 2948
AddCartesianMesh() ............................................................................................................. 2949
AddComment() ..................................................................................................................... 2949
AddFigure() .......................................................................................................................... 2949
AddGeneratedAMSupport() .................................................................................................. 2949
AddImage(string) .................................................................................................................. 2949
AddPredefinedAMSupport() .................................................................................................. 2949
AddSTLAMSupport() ............................................................................................................. 2950
AddSupportGroup() .............................................................................................................. 2950
CreateBuildToBaseContact() .................................................................................................. 2950
Delete() ................................................................................................................................ 2950
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2950
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2951
GetSequence(Analysis) ......................................................................................................... 2951
ResetAllSequences() .............................................................................................................. 2951
AMSupport ................................................................................................................................. 2951
Children ............................................................................................................................... 2953
Comments ............................................................................................................................ 2953
DataModelObjectCategory ................................................................................................... 2953
DensityMultiple .................................................................................................................... 2953
ElasticModulusMultipleInX .................................................................................................... 2953
ElasticModulusMultipleInY .................................................................................................... 2953
ElasticModulusMultipleInZ .................................................................................................... 2954

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

Figures ................................................................................................................................. 2954


Images ................................................................................................................................. 2954
InternalObject ...................................................................................................................... 2954
MaterialMultiplier ................................................................................................................. 2954
MultiplierEntry ...................................................................................................................... 2954
ShearModulusMultipleInXY ................................................................................................... 2955
ShearModulusMultipleInXZ ................................................................................................... 2955
ShearModulusMultipleInYZ ................................................................................................... 2955
SupportType ......................................................................................................................... 2955
ThermalConductivityMultipleInX ........................................................................................... 2955
ThermalConductivityMultipleInY ........................................................................................... 2955
ThermalConductivityMultipleInZ ........................................................................................... 2956
Volume ................................................................................................................................. 2956
WallSpacing .......................................................................................................................... 2956
WallThickness ....................................................................................................................... 2956
AddCommandSnippet() ........................................................................................................ 2956
AddComment() ..................................................................................................................... 2956
AddFigure() .......................................................................................................................... 2957
AddImage(string) .................................................................................................................. 2957
Delete() ................................................................................................................................ 2957
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2957
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2957
AMSupportGroup ....................................................................................................................... 2958
Children ............................................................................................................................... 2959
Comments ............................................................................................................................ 2959
DataModelObjectCategory ................................................................................................... 2959
DetectAboveZLocation ......................................................................................................... 2959
Figures ................................................................................................................................. 2959
GenerateOnRemesh .............................................................................................................. 2960
HangAngle ........................................................................................................................... 2960
Images ................................................................................................................................. 2960
InternalObject ...................................................................................................................... 2960
Location ............................................................................................................................... 2960
OutputType .......................................................................................................................... 2960
AddComment() ..................................................................................................................... 2961
AddFigure() .......................................................................................................................... 2961
AddGeneratedAMSupport() .................................................................................................. 2961
AddImage(string) .................................................................................................................. 2961
AddPredefinedAMSupport() .................................................................................................. 2961
AddSTLAMSupport() ............................................................................................................. 2961
Delete() ................................................................................................................................ 2962
DetectSupportFaces() ........................................................................................................... 2962
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2962
GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>) ................................ 2962
PromoteToNamedSelection() ................................................................................................ 2963
AMSupportRemovalSequence .................................................................................................... 2963
Count ................................................................................................................................... 2964
Add(IAMProcessStep) ............................................................................................................ 2964
Contains(IAMProcessStep) .................................................................................................... 2964
IndexOf(IAMProcessStep) ...................................................................................................... 2964
Insert(int, IAMProcessStep) .................................................................................................... 2965
RemoveAt(int) ...................................................................................................................... 2965

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

Swap(IAMProcessStep, IAMProcessStep) ................................................................................ 2965


Swap(int, int) ......................................................................................................................... 2966
BaseRemoval .............................................................................................................................. 2966
BuildStep .................................................................................................................................... 2966
CooldownStep ............................................................................................................................ 2967
GeneratedAMSupport ................................................................................................................. 2967
DataModelObjectCategory ................................................................................................... 2968
InternalObject ...................................................................................................................... 2969
Location ............................................................................................................................... 2969
Mode .................................................................................................................................... 2969
ClearGeneratedData() ........................................................................................................... 2969
CreateNamedSelectionOfGeneratedElements() ..................................................................... 2969
GenerateSupportBodies(Progress) ........................................................................................ 2969
HeatTreatmentStep ..................................................................................................................... 2970
IAMProcessStep .......................................................................................................................... 2970
ProcessStepType ................................................................................................................... 2970
PredefinedAMSupport ................................................................................................................ 2970
DataModelObjectCategory ................................................................................................... 2972
InternalObject ...................................................................................................................... 2972
Location ............................................................................................................................... 2972
Suppressed ........................................................................................................................... 2972
STLAMSupport ........................................................................................................................... 2973
DataModelObjectCategory ................................................................................................... 2975
ElementSize .......................................................................................................................... 2975
Filename .............................................................................................................................. 2975
InternalObject ...................................................................................................................... 2975
LengthUnits .......................................................................................................................... 2975
Source .................................................................................................................................. 2976
STL ....................................................................................................................................... 2976
STLSupportType ................................................................................................................... 2976
STLSupportView ................................................................................................................... 2976
StlWallThickness ................................................................................................................... 2976
SubsampleRate ..................................................................................................................... 2976
VoxelSize ***OBSOLETE*** Use 'ElementSize' property instead. .............................................. 2977
ClearGeneratedData() ........................................................................................................... 2977
CreateNamedSelectionOfExternalElementFaces() .................................................................. 2977
CreateNamedSelectionOfGeneratedElements() ..................................................................... 2977
ExportStl(string, Progress) ..................................................................................................... 2977
GenerateSupportBodies(Progress) ........................................................................................ 2978
ImportSTL() .......................................................................................................................... 2978
SupportRemoval ......................................................................................................................... 2978
UserStep ..................................................................................................................................... 2978
Ansys.Mechanical.DataModel.Utilities Namespace ....................................................................... 2979
BeamCoordinateSystem .............................................................................................................. 2979
Ansys.Mechanical.DataModel.SolverData Namespace .................................................................. 2981
MAPDLAMSupportData .............................................................................................................. 2982
MaterialIds ............................................................................................................................ 2982
RealConstantId ..................................................................................................................... 2982
MAPDLBeamData ....................................................................................................................... 2982
MaterialId ............................................................................................................................. 2982
MAPDLBearingData .................................................................................................................... 2983
MAPDLBodyData ........................................................................................................................ 2983

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

ElementTypeIds .................................................................................................................... 2983


MaterialIds ............................................................................................................................ 2983
RealConstantId ..................................................................................................................... 2983
MAPDLBoltPretensionData .......................................................................................................... 2984
PretensionNodeIds ............................................................................................................... 2984
RealConstantIds .................................................................................................................... 2984
MAPDLContactData .................................................................................................................... 2984
SourceId ............................................................................................................................... 2985
TargetId ................................................................................................................................ 2985
MAPDLCoordinateSystemData .................................................................................................... 2985
SystemId .............................................................................................................................. 2985
MAPDLJointData ........................................................................................................................ 2985
MAPDLLayeredSectionData ........................................................................................................ 2985
SectionId .............................................................................................................................. 2986
MAPDLRemotePointData ............................................................................................................ 2986
NodeId ................................................................................................................................. 2986
MAPDLSolverData ...................................................................................................................... 2986
MaxElementId ...................................................................................................................... 2987
MaxElementTypeId ............................................................................................................... 2987
MaxNodeId ........................................................................................................................... 2987
MAPDLSpringData ...................................................................................................................... 2987
MAPDLSurfaceCoatingData ......................................................................................................... 2987
MaterialId ............................................................................................................................. 2988
MAPDLSurfaceLoadData ............................................................................................................. 2988
SurfaceEffectElementTypeId ................................................................................................. 2988
SolverData .................................................................................................................................. 2988
GetObjectData(IDataModelObject) ....................................................................................... 2988
Ansys.Mechanical.DataModel.Results Namespace ........................................................................ 2991
ResultDataTable .......................................................................................................................... 2991
Count ................................................................................................................................... 2991
Item(string) .......................................................................................................................... 2992
Keys ..................................................................................................................................... 2992
Values ................................................................................................................................... 2992
ContainsKey(string) ............................................................................................................... 2992
ResultVariable ............................................................................................................................. 2992
Count ................................................................................................................................... 2993
Item(int) ............................................................................................................................... 2993
Ansys.Mechanical.DataModel.Enums Namespace ......................................................................... 2995
ActiveOrInactive ......................................................................................................................... 3007
AggressiveRemeshingType ......................................................................................................... 3007
AMCooldownTimeType ............................................................................................................... 3008
AMInherentStrainDefinition ........................................................................................................ 3008
AMLayerHeightType ................................................................................................................... 3008
AMMultiplierEntryType ............................................................................................................... 3009
AMProcessSettingsType .............................................................................................................. 3009
AMProcessSimulationType .......................................................................................................... 3009
AMProcessStepType .................................................................................................................... 3009
AMProcessType .......................................................................................................................... 3010
AMReferenceTemperatureType ................................................................................................... 3010
AMRelaxationTemperatureType .................................................................................................. 3010
AMStlSource ............................................................................................................................... 3011
AMSupportGroupOutputType ..................................................................................................... 3011

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

AMSupportSTLType .................................................................................................................... 3011


AMSupportType ......................................................................................................................... 3012
AnalysisType ............................................................................................................................... 3012
ApplicationType ......................................................................................................................... 3012
ArtificiallyMatchedLayers ............................................................................................................ 3013
AutoDetectionType ..................................................................................................................... 3013
AutomaticOrManual ................................................................................................................... 3013
AutomaticTimeStepping ............................................................................................................. 3014
AxisSelectionType ....................................................................................................................... 3014
BaseResultType ........................................................................................................................... 3014
BeamBeamContactDetectionType ............................................................................................... 3014
BeamEndReleaseBehavior ........................................................................................................... 3015
BeamOffsetType ......................................................................................................................... 3015
BeamSolutionType ...................................................................................................................... 3015
BeamToolStressResultType .......................................................................................................... 3016
BodyInteractionFormulation ....................................................................................................... 3016
BodyTreatment ........................................................................................................................... 3016
BodyType ................................................................................................................................... 3017
BoltLoadDefineBy ....................................................................................................................... 3017
BoltResultType ............................................................................................................................ 3017
BondedBreakableType ................................................................................................................ 3018
BoundaryConditionAlongFiber ................................................................................................... 3018
BoundaryConditionForRotation .................................................................................................. 3018
BoundaryConditionSelectionType ............................................................................................... 3019
BoundaryConditionType ............................................................................................................. 3019
BrickIntegrationScheme .............................................................................................................. 3019
CacheResultsInMemory .............................................................................................................. 3019
CalculateParticipationFactorResult .............................................................................................. 3020
CameraAxisType ......................................................................................................................... 3020
CampbellDiagramRotationalVelocitySelectionType ..................................................................... 3021
ChartAxisScaleType ..................................................................................................................... 3021
ChartGridlines ............................................................................................................................ 3021
ChartModalType ......................................................................................................................... 3021
ChartPlotStyle ............................................................................................................................. 3022
ChartReportType ........................................................................................................................ 3022
ChartResultType ......................................................................................................................... 3022
ChartScale .................................................................................................................................. 3023
CombineRestartFilesType ............................................................................................................ 3023
CommandEditorTarget ................................................................................................................ 3024
ComparePartsOnUpdateType ...................................................................................................... 3024
ComparePartsToleranceType ....................................................................................................... 3024
CondensedPartCMSAttachmentMethod ...................................................................................... 3025
CondensedPartExpansionType .................................................................................................... 3025
CondensedPartInterfaceMethod ................................................................................................. 3025
CondensedPartPhysics ................................................................................................................ 3026
CondensedPartReductionMethod ............................................................................................... 3026
ConnectionScopingType ............................................................................................................. 3026
ConstantDampingType ............................................................................................................... 3027
ContactBehavior ......................................................................................................................... 3027
ContactBoltThreadHand ............................................................................................................. 3027
ContactBoltThreadType .............................................................................................................. 3027
ContactConstraintType ............................................................................................................... 3028

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

ContactCorrection ...................................................................................................................... 3028


ContactDetection ....................................................................................................................... 3028
ContactDetectionPoint ............................................................................................................... 3029
ContactEdgeEdgeOption ............................................................................................................ 3029
ContactElasticSlipToleranceType ................................................................................................. 3029
ContactFaceEdgeOption ............................................................................................................. 3030
ContactFaceEdgePriority ............................................................................................................. 3030
ContactForceType ....................................................................................................................... 3030
ContactFormulation .................................................................................................................... 3031
ContactGroupingType ................................................................................................................ 3031
ContactInitialEffect ..................................................................................................................... 3031
ContactOrientation ..................................................................................................................... 3032
ContactPenetrationToleranceType ............................................................................................... 3032
ContactPinballType ..................................................................................................................... 3032
ContactResultType ...................................................................................................................... 3033
ContactScopingType ................................................................................................................... 3033
ContactSearchingType ................................................................................................................ 3033
ContactSideScopingType ............................................................................................................ 3034
ContactSmallSlidingType ............................................................................................................ 3034
ContactSplitType ........................................................................................................................ 3034
ContactSummaryType ................................................................................................................ 3035
ContactTimeStepControls ........................................................................................................... 3035
ContactToleranceType ................................................................................................................ 3035
ContactTrimType ........................................................................................................................ 3036
ContactType ............................................................................................................................... 3036
ConvectionTableSelection ........................................................................................................... 3037
ConvergenceControlType ............................................................................................................ 3037
ConvergenceToleranceType ........................................................................................................ 3037
ConvergenceType ....................................................................................................................... 3037
CoordinateSystemAlignmentType ............................................................................................... 3038
CoordinateSystemAxisType ......................................................................................................... 3038
CoordinateSystemType ............................................................................................................... 3039
CoreResultType ........................................................................................................................... 3039
CouplingConditionDOFType ....................................................................................................... 3039
CrackGrowthIncrementType ....................................................................................................... 3040
CrackGrowthMethodology .......................................................................................................... 3040
CrackGrowthOption .................................................................................................................... 3040
CrackMeshMethod ...................................................................................................................... 3040
CrackSelectionModeType ............................................................................................................ 3041
CrackShapeType ......................................................................................................................... 3041
CrackSourceType ........................................................................................................................ 3041
Creep ......................................................................................................................................... 3042
CrossSectionType ....................................................................................................................... 3042
CyclicHarmonicIndex .................................................................................................................. 3042
CylindricalFacesOption ............................................................................................................... 3042
DamageResultType ..................................................................................................................... 3043
DampingType ............................................................................................................................. 3043
DataModelObjectCategory ......................................................................................................... 3043
DeformationType ***OBSOLETE*** Use 'TotalOrDirectional' property instead. .............................. 3059
DelaminationFailureCriteriaOption .............................................................................................. 3060
DelaminationGenerationMethod ................................................................................................ 3060
DelaminationMethod .................................................................................................................. 3060

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

DelaminationType ...................................................................................................................... 3060


DiagonalOrConsistent ................................................................................................................. 3061
DistributedMassInputType .......................................................................................................... 3061
DropDirection ............................................................................................................................. 3061
DropTestDefineBy ....................................................................................................................... 3062
DSCampbellAxisRange ................................................................................................................ 3062
DSCampbellYAxisDataType ......................................................................................................... 3062
DSRBDContactDetection ............................................................................................................. 3063
ECADFidelity ............................................................................................................................... 3063
EdgeType ................................................................................................................................... 3063
EigenSolverType ......................................................................................................................... 3064
ElementControl .......................................................................................................................... 3064
ElementControlsNormalStiffnessType .......................................................................................... 3065
ElementControlsStatus ................................................................................................................ 3065
ElementMidsideNodesType ......................................................................................................... 3065
ElementMorphingType ............................................................................................................... 3065
ElementOrder ............................................................................................................................. 3066
ElementOrientationAxisType ....................................................................................................... 3066
ElementOrientationGuide ........................................................................................................... 3066
EnclosureType ............................................................................................................................ 3067
EquationSolverType .................................................................................................................... 3067
ExcitationType ............................................................................................................................ 3067
ExclusionParticipantType ............................................................................................................ 3068
EXDArtificialViscosityForShellsType ............................................................................................. 3068
EXDAutomaticMassScalingType .................................................................................................. 3068
EXDBeamSolutionType ............................................................................................................... 3069
EXDCharZoneDimensionType ..................................................................................................... 3069
EXDDensityUpdateType .............................................................................................................. 3069
EXDErosionOnGeomStrainType ................................................................................................... 3070
EXDErosionOnMaterialFailureType .............................................................................................. 3070
EXDErosionOnMinElemTimestepType ......................................................................................... 3070
EXDErosionRetainIntertiaType ..................................................................................................... 3071
EXDEulerBoundaryDefType ......................................................................................................... 3071
EXDEulerDomScopeDefType ....................................................................................................... 3071
EXDEulerResolutionDefType ....................................................................................................... 3072
EXDEulerSizeDefType .................................................................................................................. 3072
EXDEulerTrackType ..................................................................................................................... 3072
EXDHexIntegrationType .............................................................................................................. 3073
EXDHourglassDampingType ....................................................................................................... 3073
EXDLinearViscosityExpansionType .............................................................................................. 3073
EXDLoadStepType ...................................................................................................................... 3074
EXDOutputContactForcesOnType ............................................................................................... 3074
EXDPreferenceType .................................................................................................................... 3074
EXDSavePrintSummaryOnType ................................................................................................... 3075
EXDSaveProbeDataOnType ......................................................................................................... 3075
EXDSaveRestartsOnType ............................................................................................................. 3075
EXDSaveResultsOnType .............................................................................................................. 3076
EXDSaveUserEditOnType ............................................................................................................ 3076
EXDShellInertiaUpdateType ........................................................................................................ 3076
EXDShellThicknessUpdateType ................................................................................................... 3077
EXDShellWarpCorrectionType ..................................................................................................... 3077
EXDSolverPrecisionType .............................................................................................................. 3077

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

EXDSolveUnitsType ..................................................................................................................... 3078


EXDStepawareOutputControlsType ............................................................................................. 3078
EXDTetPressureIntegrationType .................................................................................................. 3078
ExpandResultFrom ...................................................................................................................... 3079
ExpandResultsSubType ............................................................................................................... 3079
ExportTopologyFileOption .......................................................................................................... 3079
ExternalEnhancedModelType ...................................................................................................... 3080
ExternalLoadApplicationType ..................................................................................................... 3080
FaceMeshingMethod .................................................................................................................. 3080
FaceType .................................................................................................................................... 3081
FarFieldMicrophoneDefinitionMethodType ................................................................................. 3081
FarFieldRadiationSurfaceType ..................................................................................................... 3081
FatigueAnalysisType ................................................................................................................... 3082
FatigueFrequencySelection ......................................................................................................... 3082
FatigueLoadType ........................................................................................................................ 3082
FatigueSensitivityType ................................................................................................................ 3083
FatigueStressComponentType .................................................................................................... 3083
FatigueToolAnalysisType ............................................................................................................. 3083
FatigueToolMethod .................................................................................................................... 3084
FatigueToolResultsInputType ...................................................................................................... 3084
FEConnectionDisplay .................................................................................................................. 3084
FEConnectionDisplayType ........................................................................................................... 3085
FEConnectionLineColor .............................................................................................................. 3085
FEConnectionLineThicknessType ................................................................................................ 3085
FilterType ................................................................................................................................... 3086
FixedOrFree ................................................................................................................................ 3086
FluentExportMeshType ............................................................................................................... 3086
FluidBehavior ............................................................................................................................. 3086
FluidDiscretizationType ............................................................................................................... 3087
FractureAffectedZone ................................................................................................................. 3087
FractureSIFSProbeSubType ......................................................................................................... 3087
FrequencyRangeType ................................................................................................................. 3088
FrequencySpacingType ............................................................................................................... 3088
FutureIntentType ........................................................................................................................ 3088
GapDefinedBy ............................................................................................................................ 3089
GapDensityType ......................................................................................................................... 3089
GAPDirectionType ...................................................................................................................... 3089
GasketResultType ....................................................................................................................... 3090
GeneralMiscellaneousOptionType ............................................................................................... 3090
GeometryDefineByType .............................................................................................................. 3090
GeometryDimensionType ........................................................................................................... 3091
GeometryType ............................................................................................................................ 3092
GPUAccelerationDevicesType ...................................................................................................... 3092
GraphControlsXAxis .................................................................................................................... 3092
Graphics3DExportFormat ............................................................................................................ 3093
GraphicsAnimationExportFormat ................................................................................................ 3093
GraphicsBackgroundType ........................................................................................................... 3093
GraphicsCaptureType ................................................................................................................. 3094
GraphicsImageExportFormat ...................................................................................................... 3094
GraphicsResolutionType ............................................................................................................. 3094
GravityOrientationType ............................................................................................................... 3095
GrowElbowElementsBy ............................................................................................................... 3095

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

HarmonicMethod ....................................................................................................................... 3095


HarmonicMSUPStorage ............................................................................................................... 3096
HarmonicVariationalTechnology ................................................................................................. 3096
HexIntegrationType .................................................................................................................... 3096
HourglassDampingType .............................................................................................................. 3097
ICEMCFDBehavior ....................................................................................................................... 3097
ImportedLoadType ..................................................................................................................... 3097
ImportParameterType ................................................................................................................. 3098
IncidentWaveLocation ................................................................................................................ 3098
InitialClearanceType .................................................................................................................... 3098
InitialConditionsType .................................................................................................................. 3099
InitialTemperatureType ............................................................................................................... 3099
IterationOptions ......................................................................................................................... 3099
JointConditionType .................................................................................................................... 3100
JointFormulation ........................................................................................................................ 3100
JointFrictionType ........................................................................................................................ 3100
JointInitialPosition ...................................................................................................................... 3101
JointRotationDOFType ................................................................................................................ 3101
JointScopingType ....................................................................................................................... 3101
JointSolverElementType .............................................................................................................. 3102
JointStopType ............................................................................................................................. 3102
JointType .................................................................................................................................... 3102
KinematicDOF ............................................................................................................................ 3103
LatticeType ................................................................................................................................. 3103
LifeUnitsType .............................................................................................................................. 3104
Linearized2DBehavior ................................................................................................................. 3104
LinearizedSubtype ...................................................................................................................... 3105
LineSearchType .......................................................................................................................... 3105
LoadAppliedBy ........................................................................................................................... 3105
LoadBehavior ............................................................................................................................. 3106
LoadDefineBy ............................................................................................................................. 3106
LoadingApplicationType ............................................................................................................. 3107
LoadVariableVariationType .......................................................................................................... 3107
LoadVariationSubOption ............................................................................................................. 3111
LoadVariationType ...................................................................................................................... 3112
LocationDefinitionMethod .......................................................................................................... 3112
LowReducedFrequencyModelType ............................................................................................. 3113
ManualContactTreatmentType .................................................................................................... 3113
ManufacturingConstraintSubtype ............................................................................................... 3113
ManuMemberSizeControlledType ............................................................................................... 3114
MeanStressTheoryType ............................................................................................................... 3114
MeshDisplayStyle ........................................................................................................................ 3114
MeshElementShape .................................................................................................................... 3115
MeshMethodAlgorithm .............................................................................................................. 3115
MeshMetricType ......................................................................................................................... 3116
MeshNodeType .......................................................................................................................... 3116
MeshPhysicsPreferenceType ....................................................................................................... 3117
MeshRestartControlsType ........................................................................................................... 3117
MeshRestartRetainFilesType ........................................................................................................ 3117
MeshRestartSaveAtLoadStep ...................................................................................................... 3118
MeshRestartSaveAtSubstep ........................................................................................................ 3118
MeshSolverPreferenceType ......................................................................................................... 3118

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

MessageSeverityType ................................................................................................................. 3118


MethodType ............................................................................................................................... 3119
MinimumOrMaximum ................................................................................................................ 3119
ModalFrequencyRangeType ........................................................................................................ 3120
Model2DBehavior ....................................................................................................................... 3120
ModelType ................................................................................................................................. 3120
ModesCombinationType ............................................................................................................. 3121
MomentsAtSummationPointType ............................................................................................... 3121
MPIType ..................................................................................................................................... 3121
MultipleNodeType ...................................................................................................................... 3121
NamedSelectionWorksheetOperator ........................................................................................... 3122
NewtonRaphsonType .................................................................................................................. 3122
NodeMoveInformationType ........................................................................................................ 3122
NodeSelection ............................................................................................................................ 3123
NonlinearAdaptivityControlsRefinementAlgorithmType .............................................................. 3123
NonlinearAdaptivityControlsRemeshingGradientType ................................................................. 3123
NonlinearAdaptivityCriterionType ............................................................................................... 3123
NonlinearAdaptivityOptionType .................................................................................................. 3124
NonlinearAdaptivityTimeRange .................................................................................................. 3124
NonlinearAdaptivityUpdateType ................................................................................................. 3124
NonLinearFormulationType ......................................................................................................... 3125
NonLinearValueType ................................................................................................................... 3125
NormalOrientationType .............................................................................................................. 3125
ObjectiveType ............................................................................................................................ 3126
ObjectState ................................................................................................................................ 3126
OptimizationResponseConstraintComponentType ...................................................................... 3127
OptimizationSolverType .............................................................................................................. 3127
OptimizationType ....................................................................................................................... 3127
OutputControlsNodalForcesType ................................................................................................ 3128
PartTransformationDefinitionType .............................................................................................. 3128
PassFailResult ............................................................................................................................. 3128
PatchIndependentDefineType ..................................................................................................... 3129
PathScopingType ........................................................................................................................ 3129
PeriodicityDirectionType ............................................................................................................. 3129
PeriodicRegionType .................................................................................................................... 3130
PFactorResultType ...................................................................................................................... 3130
PhaseType .................................................................................................................................. 3130
PhysicsType ................................................................................................................................ 3131
PipeLoadingType ........................................................................................................................ 3131
PMLOptions ................................................................................................................................ 3132
PolyflowExportUnit ..................................................................................................................... 3132
PortAttribution ........................................................................................................................... 3132
PortBehavior ............................................................................................................................... 3132
PortPosition ................................................................................................................................ 3133
PressureAtZeroPenetrationType .................................................................................................. 3133
PressureInitializationType ........................................................................................................... 3133
PreStressContactStatus ............................................................................................................... 3134
PreStressMode ............................................................................................................................ 3134
PreStressStateType ..................................................................................................................... 3134
ProbeDisplayFilter ....................................................................................................................... 3134
ProbeExtractionType ................................................................................................................... 3136
ProbeResultType ......................................................................................................................... 3136

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

PrototypeDisplayStyleType ......................................................................................................... 3138


PrototypeLinkBehavior ............................................................................................................... 3138
PrototypeModelType .................................................................................................................. 3138
ProximitySFSourcesType ............................................................................................................. 3139
PSDBoundaryConditionSelectionType ......................................................................................... 3139
PullOutDirectionType .................................................................................................................. 3139
RadiationType ............................................................................................................................. 3140
RadiositySolverType .................................................................................................................... 3140
RadiosityViewFactorType ............................................................................................................ 3140
RadiusOfReferenceSphereDefineBy ............................................................................................. 3140
RandomSamplingType ................................................................................................................ 3141
RBDCorrectionType ..................................................................................................................... 3141
RBDDoStaticAnalysisType ........................................................................................................... 3141
RBDProgramControlType ............................................................................................................ 3142
RBDTimeIntegrationType ............................................................................................................ 3142
ReactionForceCriteriaType .......................................................................................................... 3143
ReferenceFrameType .................................................................................................................. 3143
ReflectionCoefficientsType .......................................................................................................... 3143
RemoteApplicationType .............................................................................................................. 3144
RemotePointDOFSelectionType .................................................................................................. 3144
ResponseConstraintDefineBy ...................................................................................................... 3144
ResponseConstraintType ............................................................................................................. 3145
RestartControlsType .................................................................................................................... 3145
RestartRetainFilesType ................................................................................................................ 3145
RestartSaveAtLoadStep ............................................................................................................... 3146
RestartSaveAtSubstep ................................................................................................................. 3146
RestartType ................................................................................................................................ 3146
ResultAnimationRangeType ........................................................................................................ 3147
ResultAveragingType .................................................................................................................. 3147
ResultFileCompressionType ........................................................................................................ 3147
ResultFileItemType ..................................................................................................................... 3148
ResultRelativityType .................................................................................................................... 3148
ResultType .................................................................................................................................. 3148
RigidResponseEffectType ............................................................................................................ 3156
RotationPlane ............................................................................................................................. 3157
RSBoundaryConditionSelectionType ........................................................................................... 3157
SafetyLimitType .......................................................................................................................... 3157
SafetyTheoryType ....................................................................................................................... 3157
ScaleFactorType .......................................................................................................................... 3158
ScatteredFieldFormulation .......................................................................................................... 3158
ScatteringOutputType ................................................................................................................ 3158
SecondaryImportPrefType .......................................................................................................... 3159
SectionPlaneCappingType .......................................................................................................... 3159
SectionPlaneType ....................................................................................................................... 3159
SelectionActionType ................................................................................................................... 3160
SelectionCriterionType ................................................................................................................ 3160
SelectionOperatorType ............................................................................................................... 3162
SelectionType ............................................................................................................................. 3163
SendAs ....................................................................................................................................... 3164
SeqSelectionMode ...................................................................................................................... 3164
SequenceSelectionType .............................................................................................................. 3164
SetDriverStyle ............................................................................................................................. 3165

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

ShearMomentDiagramOrientationType ....................................................................................... 3165


ShearMomentType ..................................................................................................................... 3166
ShearOrientationType ................................................................................................................. 3166
ShellBodyDimension ................................................................................................................... 3166
ShellFaceType ............................................................................................................................. 3166
ShellInertiaUpdate ...................................................................................................................... 3167
ShellMBPOrientationType ........................................................................................................... 3167
ShellMBPType ............................................................................................................................. 3167
ShellOffsetType ........................................................................................................................... 3168
ShellThicknessUpdate ................................................................................................................. 3168
SizingBehavior ............................................................................................................................ 3168
SizingType .................................................................................................................................. 3169
SlidingContactType ..................................................................................................................... 3169
SnapType ................................................................................................................................... 3169
SolutionCombinationDriverStyle ................................................................................................. 3170
SolutionCombinationWorksheetType .......................................................................................... 3170
SolutionOutputType ................................................................................................................... 3170
SolutionStatusType ..................................................................................................................... 3171
SolverControlsIncludeNegativeLoadMultiplier ............................................................................. 3172
SolverControlsModeReuse .......................................................................................................... 3172
SolverPivotChecking ................................................................................................................... 3172
SolverType .................................................................................................................................. 3173
SolverUnitsControlType .............................................................................................................. 3173
SortingType ................................................................................................................................ 3173
SourceConductorType ................................................................................................................ 3174
SourceDimension ....................................................................................................................... 3174
SpacingOptionType .................................................................................................................... 3174
SpatialRadiationType .................................................................................................................. 3175
SpatialReductionMethodType ..................................................................................................... 3175
SpatialReductionType ................................................................................................................. 3175
SpectrumType ............................................................................................................................ 3175
SpinSofteningType ..................................................................................................................... 3176
SpringBehavior ........................................................................................................................... 3176
SpringPreloadType ..................................................................................................................... 3176
SpringResultType ........................................................................................................................ 3177
SpringScopingType ..................................................................................................................... 3177
SpringsStiffnessType ................................................................................................................... 3177
SpringType ................................................................................................................................. 3178
StabilizationFirstSubstepOption .................................................................................................. 3178
StabilizationMethod ................................................................................................................... 3178
StabilizationType ........................................................................................................................ 3179
StiffnessBehavior ........................................................................................................................ 3179
StiffnessMethodType .................................................................................................................. 3179
STLSupportViewType .................................................................................................................. 3180
StopAtMaxCrackExtensionType ................................................................................................... 3180
StoreModalResult ....................................................................................................................... 3180
StressStrainType ......................................................................................................................... 3180
SubScopingDefineByType ........................................................................................................... 3181
SurfaceCoatingStiffnessBehavior ................................................................................................. 3181
SweepElementOptionType .......................................................................................................... 3182
SymmetryBehavior ..................................................................................................................... 3182
SymmetryBoundaryDOFOrientation ............................................................................................ 3182

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

SymmetryNormalType ................................................................................................................ 3182


SymmetryRegionType ................................................................................................................. 3183
TargetCorrection ......................................................................................................................... 3183
TargetOrientation ....................................................................................................................... 3183
TetIntegrationType ..................................................................................................................... 3184
ThermalPointMassBehavior ......................................................................................................... 3184
ThermalStrainType ...................................................................................................................... 3184
ThermoelasticDampingType ....................................................................................................... 3185
ThroughThicknessBendingStress ................................................................................................. 3185
TimeHistoryDisplayType ............................................................................................................. 3185
TimePointsOptions ..................................................................................................................... 3186
TimeStepDefineByType ............................................................................................................... 3186
ToleranceType ............................................................................................................................ 3186
TopoBoundType ......................................................................................................................... 3186
TopoConstraintType .................................................................................................................... 3187
TopoEnvironmentType ................................................................................................................ 3187
TopologyOptimizationResultShowType ....................................................................................... 3187
TopoObjectiveFormulation ......................................................................................................... 3188
TopoOptimizationDensityFilter ................................................................................................... 3188
TopoOptimizationOutputLog ...................................................................................................... 3188
TotalOrDirectional ...................................................................................................................... 3189
TransferAdmittanceModelType ................................................................................................... 3189
TransformationType .................................................................................................................... 3189
TransientApplicationType ........................................................................................................... 3189
TransientDampingType ............................................................................................................... 3190
TreeFilterObjectClass .................................................................................................................. 3190
TreeFilterObjectState .................................................................................................................. 3190
TreeFilterScopingType ................................................................................................................ 3191
UnitCategoryType ....................................................................................................................... 3191
UnitSystemIDType ...................................................................................................................... 3194
UpdateContactStiffness .............................................................................................................. 3195
UseExistingModesymFile ............................................................................................................ 3195
UserUnitSystemType ................................................................................................................... 3195
VectorReductionReferenceType .................................................................................................. 3196
VectorReductionType .................................................................................................................. 3196
ViewOrientationType .................................................................................................................. 3196
VirtualCellClassType .................................................................................................................... 3197
VirtualCellGroupAutomaticBehaviorType .................................................................................... 3197
VirtualCellGroupMethodType ...................................................................................................... 3197
VirtualCellGroupRepairBehaviorType ........................................................................................... 3198
VisibilityType .............................................................................................................................. 3198
WaveType ................................................................................................................................... 3198
WBUnitSystemType .................................................................................................................... 3199
WeakSpringsType ....................................................................................................................... 3200
XAxisValues ................................................................................................................................ 3200
YesNoProgrammedControlled ..................................................................................................... 3200
YesNoType .................................................................................................................................. 3200
Ansys.ACT.Math Namespace ........................................................................................................... 3203
Matrix4D .................................................................................................................................... 3203
Matrix4D() ............................................................................................................................ 3204
Matrix4D(double[]) ............................................................................................................... 3204
Matrix4D(Matrix4D) .............................................................................................................. 3205

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

Identity ................................................................................................................................. 3205


Determinant ......................................................................................................................... 3205
Item(int, int) .......................................................................................................................... 3205
Item(int) ............................................................................................................................... 3205
Add(Matrix4D) ...................................................................................................................... 3206
CreateMirror(Vector3D, double) ............................................................................................. 3206
CreateRotate(Vector3D, double) ............................................................................................ 3206
CreateScale(double, double, double) ..................................................................................... 3207
CreateSystem(Vector3D, Vector3D, Vector3D) ......................................................................... 3207
CreateTranslate(double, double, double) ................................................................................ 3207
Invert() ................................................................................................................................. 3208
Multiply(Matrix4D) ................................................................................................................ 3208
Scale(double, double, double) ............................................................................................... 3208
Subtract(Matrix4D) ............................................................................................................... 3208
ToString() .............................................................................................................................. 3209
Transform(Vector3D) ............................................................................................................. 3209
Translate(double, double, double) .......................................................................................... 3209
Transpose() ........................................................................................................................... 3210
op_Addition(Matrix4D, Matrix4D) .......................................................................................... 3210
op_Explicit(Matrix4D) ........................................................................................................... 3210
op_Multiply(Matrix4D, Matrix4D) ........................................................................................... 3210
op_Subtraction(Matrix4D, Matrix4D) ..................................................................................... 3211
Vector3D .................................................................................................................................... 3211
Vector3D(double[]) ............................................................................................................... 3212
Vector3D(Vector3D) .............................................................................................................. 3212
Vector3D(double, double, double) ......................................................................................... 3213
I ............................................................................................................................................ 3213
IJK ........................................................................................................................................ 3213
J ........................................................................................................................................... 3213
K .......................................................................................................................................... 3214
X .......................................................................................................................................... 3214
Y .......................................................................................................................................... 3214
Z .......................................................................................................................................... 3214
Zero ..................................................................................................................................... 3214
Item(int) ............................................................................................................................... 3214
Magnitude ............................................................................................................................ 3215
MagnitudeSquared ............................................................................................................... 3215
Add(Vector3D) ...................................................................................................................... 3215
CloneNormalized() ................................................................................................................ 3215
Cross(Vector3D, Vector3D) ..................................................................................................... 3215
CrossProduct(Vector3D) ........................................................................................................ 3216
Dot(Vector3D, Vector3D) ....................................................................................................... 3216
DotProduct(Vector3D) .......................................................................................................... 3216
Equals(object) ....................................................................................................................... 3217
GetDistance(Vector3D, Vector3D) .......................................................................................... 3217
GetDistanceSquared(Vector3D, Vector3D) ............................................................................. 3217
GetHashCode() ..................................................................................................................... 3217
Normalize() ........................................................................................................................... 3218
Subtract(Vector3D) ............................................................................................................... 3218
ToString() .............................................................................................................................. 3218
op_Addition(Vector3D, Vector3D) .......................................................................................... 3218
op_Division(Vector3D, double) .............................................................................................. 3219

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

op_Equality(Vector3D, Vector3D) ........................................................................................... 3219


op_Explicit(Vector3D) ........................................................................................................... 3219
op_Inequality(Vector3D, Vector3D) ........................................................................................ 3219
op_Multiply(double, Vector3D) .............................................................................................. 3220
op_Multiply(Vector3D, double) ............................................................................................. 3220
op_Multiply(Vector3D, Vector3D) .......................................................................................... 3220
op_Subtraction(Vector3D, Vector3D) ..................................................................................... 3221
op_UnaryNegation(Vector3D) ............................................................................................... 3221
Ansys.ACT.Interfaces.Workflow Namespace .................................................................................. 3223
ITask ........................................................................................................................................... 3223
Caption ................................................................................................................................ 3223
InternalObject ...................................................................................................................... 3224
Name ................................................................................................................................... 3224
TaskGroup ............................................................................................................................ 3224
TaskId ................................................................................................................................... 3224
ITaskGroup ................................................................................................................................. 3224
Caption ................................................................................................................................ 3225
InternalObject ...................................................................................................................... 3225
Name ................................................................................................................................... 3225
TaskGroupId ......................................................................................................................... 3225
Tasks .................................................................................................................................... 3225
ITaskInput ................................................................................................................................... 3225
ITaskOutput ................................................................................................................................ 3226
IWBParameter ............................................................................................................................. 3226
Caption ................................................................................................................................ 3226
Usage ................................................................................................................................... 3226
Value .................................................................................................................................... 3226
IWBProperty ............................................................................................................................... 3227
Value .................................................................................................................................... 3227
IWorkflowDataModel .................................................................................................................. 3227
TaskGroups ........................................................................................................................... 3228
Tasks .................................................................................................................................... 3228
GetTaskByCoordinate(string) ................................................................................................. 3228
GetTaskById(string) ............................................................................................................... 3228
GetTaskGroupByDirectoryName(string) ................................................................................. 3228
GetTaskGroupById(string) ..................................................................................................... 3229
IWorkflowTask ............................................................................................................................ 3229
InternalObject ...................................................................................................................... 3229
SourceTasks .......................................................................................................................... 3229
IWorkflowTaskGroup ................................................................................................................... 3230
InternalObject ...................................................................................................................... 3230
Tasks .................................................................................................................................... 3230
ParameterUsage ......................................................................................................................... 3230
Ansys.ACT.Interfaces.Wizard Namespace ....................................................................................... 3231
IStepUserInterface ...................................................................................................................... 3231
Panel .................................................................................................................................... 3231
GetComponent(string) .......................................................................................................... 3231
IWizard ....................................................................................................................................... 3232
CurrentStep .......................................................................................................................... 3232
Description ........................................................................................................................... 3232
Extension ............................................................................................................................. 3232
Filename .............................................................................................................................. 3233

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

Folder ................................................................................................................................... 3233


Name ................................................................................................................................... 3233
Steps .................................................................................................................................... 3233
IWizardStep ................................................................................................................................ 3233
ComponentName ................................................................................................................. 3234
Context ................................................................................................................................ 3234
HelpFile ................................................................................................................................ 3234
IsEnabled .............................................................................................................................. 3234
Layout .................................................................................................................................. 3234
NextEnabledStep .................................................................................................................. 3235
NextStep .............................................................................................................................. 3235
PreviousEnabledStep ............................................................................................................ 3235
PreviousStep ......................................................................................................................... 3235
StepId ................................................................................................................................... 3235
SystemName ........................................................................................................................ 3235
UserInterface ........................................................................................................................ 3236
Wizard .................................................................................................................................. 3236
Ansys.ACT.Interfaces.UserObject Namespace ................................................................................ 3237
IPropertyCollection ..................................................................................................................... 3237
Count ................................................................................................................................... 3238
Item(string) .......................................................................................................................... 3238
Contains(ISimProperty) ......................................................................................................... 3238
GetByName(string) ............................................................................................................... 3238
ISimProperty ............................................................................................................................... 3238
Attributes ............................................................................................................................. 3239
Caption ................................................................................................................................ 3240
Control ................................................................................................................................. 3240
Controller ............................................................................................................................. 3240
DefaultValue ......................................................................................................................... 3240
Displayed ............................................................................................................................. 3240
HasUnit ................................................................................................................................ 3240
Id ......................................................................................................................................... 3241
InternalValue ........................................................................................................................ 3241
IsGroup ................................................................................................................................ 3241
IsNativeTable ........................................................................................................................ 3241
IsTable .................................................................................................................................. 3241
IsValid ................................................................................................................................... 3241
Name ................................................................................................................................... 3242
Options ................................................................................................................................ 3242
ParentCaption ...................................................................................................................... 3242
ParentPropertyGroup ............................................................................................................ 3242
QuantityName ...................................................................................................................... 3242
ReadOnly .............................................................................................................................. 3242
StateMessage ....................................................................................................................... 3243
StateMessageType ................................................................................................................ 3243
UniqueName ........................................................................................................................ 3243
UnitString ............................................................................................................................. 3243
Value .................................................................................................................................... 3243
ValueString ........................................................................................................................... 3243
Visible .................................................................................................................................. 3244
ISimPropertyGroup ..................................................................................................................... 3244
AllDescendants ..................................................................................................................... 3244

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

Display ................................................................................................................................. 3244


Properties ............................................................................................................................. 3244
ISimPropertyTable ...................................................................................................................... 3245
ActiveRow ............................................................................................................................ 3245
RowCount ............................................................................................................................ 3245
UpdateStateFreq ................................................................................................................... 3245
ValidState ............................................................................................................................. 3245
AddRow() ............................................................................................................................. 3246
DeleteRow(int) ...................................................................................................................... 3246
SaveActiveRow() ................................................................................................................... 3246
IUserLoad ................................................................................................................................... 3246
AffectsSolution ..................................................................................................................... 3247
Color .................................................................................................................................... 3247
IsLoad ................................................................................................................................... 3247
IsSupport .............................................................................................................................. 3247
Suppressed ........................................................................................................................... 3247
CreateChild(string) ................................................................................................................ 3247
IUserObject ................................................................................................................................ 3248
AllProperties ......................................................................................................................... 3248
Attributes ............................................................................................................................. 3248
Caption ................................................................................................................................ 3249
Controller ............................................................................................................................. 3249
Extension ............................................................................................................................. 3249
Icon ...................................................................................................................................... 3249
Id ......................................................................................................................................... 3249
Name ................................................................................................................................... 3249
Properties ............................................................................................................................. 3250
State ..................................................................................................................................... 3250
Version ................................................................................................................................. 3250
NotifyChange() ..................................................................................................................... 3250
IUserResult ................................................................................................................................. 3250
CalculateTimeHistory ............................................................................................................ 3251
HasImaginary ....................................................................................................................... 3251
ResultAveraging ................................................................................................................... 3251
ResultLocation ...................................................................................................................... 3251
ResultType ............................................................................................................................ 3251
Suppressed ........................................................................................................................... 3252
Unit ...................................................................................................................................... 3252
IUserSolver ................................................................................................................................. 3252
AnalysisType ......................................................................................................................... 3252
PhysicsType .......................................................................................................................... 3252
ObjectLocationEnum .................................................................................................................. 3253
ObjectTypeEnum ........................................................................................................................ 3253
PropertyDisplayEnum ................................................................................................................. 3253
UpdateStateFreqEnum ................................................................................................................ 3254
ValidStateEnum .......................................................................................................................... 3254
Ansys.ACT.Interfaces.UserInterface Namespace ............................................................................ 3255
ButtonClickedEventArgs ............................................................................................................. 3255
ButtonPositionType .................................................................................................................... 3256
EntryTypeEnum .......................................................................................................................... 3256
IComponentRenderer ................................................................................................................. 3256
Container ............................................................................................................................. 3256

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

InitDataFromJson(string) ....................................................................................................... 3256


Refresh() ............................................................................................................................... 3257
IContainer ................................................................................................................................... 3257
LastMouseX .......................................................................................................................... 3257
LastMouseY .......................................................................................................................... 3258
Name ................................................................................................................................... 3258
Renderer .............................................................................................................................. 3258
Hide() ................................................................................................................................... 3258
LocalToGlobal(int, int, out Int32, out Int32) ............................................................................. 3258
ShowPanel(IPanel) ................................................................................................................ 3259
IEntry ......................................................................................................................................... 3259
Caption ................................................................................................................................ 3259
Checked ............................................................................................................................... 3259
Enabled ................................................................................................................................ 3260
Entries .................................................................................................................................. 3260
EntryType ............................................................................................................................. 3260
Visible .................................................................................................................................. 3260
INamed ...................................................................................................................................... 3260
Name ................................................................................................................................... 3261
INamedCollection<T> ................................................................................................................. 3261
Item(string) .......................................................................................................................... 3261
Names .................................................................................................................................. 3261
IProgressMonitor ........................................................................................................................ 3261
CanAbort .............................................................................................................................. 3262
CanInterrupt ......................................................................................................................... 3262
CompletedWorkUnits ............................................................................................................ 3263
Parent ................................................................................................................................... 3263
PropagateWorkDetails .......................................................................................................... 3263
PropagateWorkStatus ........................................................................................................... 3263
Status ................................................................................................................................... 3263
TotalWorkUnits ..................................................................................................................... 3263
WorkDetails .......................................................................................................................... 3264
WorkName ........................................................................................................................... 3264
WorkStatus ........................................................................................................................... 3264
BeginWork(string, double) ..................................................................................................... 3264
CreateChildMonitor(double) ................................................................................................. 3264
EndWork() ............................................................................................................................. 3265
UpdateWork(double) ............................................................................................................ 3265
IRenderer .................................................................................................................................... 3265
CreateDialogContainer(string, int, int, int, int) ......................................................................... 3266
CreatePanelContainer(string, string, int, int) ............................................................................ 3266
CreateVirtualContainer(string) .............................................................................................. 3266
GetContainer(string) ............................................................................................................. 3267
IToolbar ...................................................................................................................................... 3267
Caption ................................................................................................................................ 3267
Entries .................................................................................................................................. 3267
Visible .................................................................................................................................. 3268
IUserInterface ............................................................................................................................. 3268
IsBatchMode ......................................................................................................................... 3268
ProgressMonitor ................................................................................................................... 3268
Toolbars ............................................................................................................................... 3268
UIRenderer ........................................................................................................................... 3269

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

GetExtensionToolbars(IExtension) ......................................................................................... 3269


LinkClickedEventArgs ................................................................................................................. 3269
ListItemCheckChangedEventArgs ............................................................................................... 3269
ListItemSelectedEventArgs .......................................................................................................... 3269
ProgressStatus ............................................................................................................................ 3270
ToggleButtonClickedEventArgs ................................................................................................... 3270
Ansys.ACT.Interfaces.UserInterface.Components Namespace ...................................................... 3271
ComponentListAlignment ........................................................................................................... 3271
IButtonComponent ..................................................................................................................... 3272
ButtonClicked ....................................................................................................................... 3272
Used ..................................................................................................................................... 3272
SetBasicDatas(string, string, string) ........................................................................................ 3272
SetCaptionFontSize(int) ........................................................................................................ 3273
SetImageSize(int, int) ............................................................................................................ 3273
SetSize(int, int) ...................................................................................................................... 3273
IButtonsComponent ................................................................................................................... 3274
ButtonClicked ....................................................................................................................... 3274
AddButton(string, string, ButtonPositionType, bool, bool) ....................................................... 3274
ClearButtons() ....................................................................................................................... 3275
SetEnabledFlag(string, bool) .................................................................................................. 3275
SetMessage(string) ............................................................................................................... 3275
IButtonWithMenuComponent ..................................................................................................... 3275
IChartComponent ....................................................................................................................... 3276
Bar(IList<object>, IList<object>, IList<string>, string) ............................................................. 3276
Bubble(IList<object>, IList<object>, IList<object>, IList<string>, IList<string>, string, string) .... 3277
Pie(IList<object>, IList<object>) ............................................................................................ 3277
Plot(IList<object>, IList<object>, string, string) ...................................................................... 3278
Reset() .................................................................................................................................. 3278
ShowLegend(bool) ............................................................................................................... 3278
Title(string) ........................................................................................................................... 3279
XLabel(string) ....................................................................................................................... 3279
XTickFormat(string) .............................................................................................................. 3279
Y2Label(string) ..................................................................................................................... 3280
Y2TickFormat(string) ............................................................................................................. 3280
YLabel(string) ....................................................................................................................... 3280
YTickFormat(string) .............................................................................................................. 3280
IDygraphComponent .................................................................................................................. 3281
RangeSelectorPlotFillColor .................................................................................................... 3281
RangeSelectorPlotStrokeColor .............................................................................................. 3281
ShowRangeSelector .............................................................................................................. 3282
Title ...................................................................................................................................... 3282
XLabel .................................................................................................................................. 3282
Y2Label ................................................................................................................................ 3282
YLabel .................................................................................................................................. 3282
AddSeries(IDictionary<double, double>, string, string) ........................................................... 3282
DrawPoints(bool, string) ........................................................................................................ 3283
RemoveSeries(string) ............................................................................................................ 3283
Reset() .................................................................................................................................. 3283
IEditorComponent ...................................................................................................................... 3284
IFrameComponent ...................................................................................................................... 3284
SetHtmlContent(string) ......................................................................................................... 3284
IHelpComponent ........................................................................................................................ 3284

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

SetHtmlContent(string) ......................................................................................................... 3285


SetHtmlContent(string, string) ............................................................................................... 3285
IHtmlComponent ........................................................................................................................ 3285
SetHtmlContent(string) ......................................................................................................... 3285
IImageComponent ...................................................................................................................... 3286
IListComponent .......................................................................................................................... 3286
Alignment ............................................................................................................................ 3286
MaxColumnCount ................................................................................................................. 3287
AddComponent(IComponentRenderer, int) ........................................................................... 3287
ClearComponents(bool) ........................................................................................................ 3287
GetComponent(string) .......................................................................................................... 3287
RemoveComponentByName(string) ...................................................................................... 3288
SetOffset(float, float) ............................................................................................................. 3288
SetWidth(float, ComponentLengthType) ............................................................................... 3288
IPopupMenuComponent ............................................................................................................ 3288
IProgressComponent .................................................................................................................. 3289
Reset() .................................................................................................................................. 3289
UpdateProgress(string, int, bool, ProgressTypeMessage) ......................................................... 3289
IPropertiesComponent ................................................................................................................ 3290
PropertyChanged ................................................................................................................. 3290
UpdateData() ........................................................................................................................ 3290
ISceneGraphComponent ............................................................................................................. 3290
ISearchBarComponent ................................................................................................................ 3290
ITabularDataComponent ............................................................................................................. 3291
ITitleComponent ......................................................................................................................... 3291
ITreeComponent ......................................................................................................................... 3291
ITreeGridComponent .................................................................................................................. 3291
IsEditable .............................................................................................................................. 3291
SetModel(ITreeGridModel) .................................................................................................... 3292
ProgressTypeMessage ................................................................................................................. 3292
Ansys.ACT.Interfaces.UserInterface.Components.ToolbarComponents Namespace .................... 3293
IToolbarComponent .................................................................................................................... 3293
Ansys.ACT.Interfaces.Reporting Namespace ................................................................................. 3295
IReport ....................................................................................................................................... 3295
ChildCount ........................................................................................................................... 3295
FilePath ................................................................................................................................ 3296
ImageDirectoryPath .............................................................................................................. 3296
AddChild(IReportItem) .......................................................................................................... 3296
AddChild(IReportItem, int) .................................................................................................... 3296
GetChild(int) ......................................................................................................................... 3296
RemoveChild(int) .................................................................................................................. 3297
IReportItem ................................................................................................................................ 3297
Name ................................................................................................................................... 3297
Ansys.ACT.Interfaces.Project Namespace ...................................................................................... 3299
IProjectDataModel ...................................................................................................................... 3299
CurrentUnitFromQuantityName(string) ................................................................................. 3299
Ansys.ACT.Interfaces.Post Namespace ........................................................................................... 3301
IComponentInfo ......................................................................................................................... 3301
Name ................................................................................................................................... 3301
QuantityName ...................................................................................................................... 3302
Unit ...................................................................................................................................... 3302
ICustomResultReader .................................................................................................................. 3302

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

GetComponentNames(string) ............................................................................................... 3302


GetComponentUnit(string, string) ......................................................................................... 3303
GetResultLocation(string) ..................................................................................................... 3303
GetResultNames() ................................................................................................................. 3303
GetResultType(string) ........................................................................................................... 3303
GetStepValues() .................................................................................................................... 3304
GetValues(string, IResultCollector) ......................................................................................... 3304
SetCurrentStep(IStepInfo) ..................................................................................................... 3304
IResult ........................................................................................................................................ 3305
Components ......................................................................................................................... 3305
ForcedToDefault ................................................................................................................... 3305
Location ............................................................................................................................... 3306
Name ................................................................................................................................... 3306
GetComponentInfo(string) .................................................................................................... 3306
GetElementValues(int) .......................................................................................................... 3306
GetElementValues(IEnumerable<int>, bool) .......................................................................... 3306
GetNodeValues(IEnumerable<int>) ....................................................................................... 3307
GetNodeValues(int) ............................................................................................................... 3307
SelectComponents(IEnumerable<string>) ............................................................................. 3307
IResultCollector .......................................................................................................................... 3308
ComponentCount ................................................................................................................. 3308
HasImaginary ....................................................................................................................... 3309
Ids ........................................................................................................................................ 3309
Indices .................................................................................................................................. 3309
Lengths ................................................................................................................................ 3309
ContainsId(int) ...................................................................................................................... 3309
SetAllIds(List<int>, List<int>) ................................................................................................ 3309
SetAllValues(double[], IList<int>) ........................................................................................... 3310
SetAllValues(IEnumerable<double>, IEnumerable<int>) ........................................................ 3310
SetImaginaryValues(int, double[]) .......................................................................................... 3310
SetImaginaryValues(int, IEnumerable<double>) .................................................................... 3311
SetValues(int, double[]) ......................................................................................................... 3311
SetValues(int, IEnumerable<double>) .................................................................................... 3311
IResultReader ............................................................................................................................. 3312
ContactElementIds ............................................................................................................... 3313
ContactNodeIds .................................................................................................................... 3313
CurrentResultSet ................................................................................................................... 3313
CurrentTimeFreq .................................................................................................................. 3313
HasImaginaryResults ............................................................................................................. 3313
Layer .................................................................................................................................... 3313
LayeredSolidStressStyle ........................................................................................................ 3314
ListTimeFreq ......................................................................................................................... 3314
ResultNames ......................................................................................................................... 3314
ResultSetCount ..................................................................................................................... 3314
ShellPosition ......................................................................................................................... 3314
TransformsToGlobal .............................................................................................................. 3314
CreateMeshData() ................................................................................................................. 3315
GetResult(string, MechanicalUnitSystem) ............................................................................... 3315
NumberValuesByElement(IList<int>) ..................................................................................... 3315
IStepInfo ..................................................................................................................................... 3315
DefineBy ............................................................................................................................... 3316
Set ........................................................................................................................................ 3316

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

Time ..................................................................................................................................... 3316


ResultAveragingEnum ................................................................................................................. 3316
ResultLocationEnum ................................................................................................................... 3317
ResultTypeEnum ......................................................................................................................... 3317
ShellPosition ............................................................................................................................... 3317
StepDefineByEnum ..................................................................................................................... 3318
StressStyle .................................................................................................................................. 3318
Ansys.ACT.Interfaces.Mesh Namespace ......................................................................................... 3319
ElementTypeEnum ...................................................................................................................... 3319
IElement ..................................................................................................................................... 3320
Area ..................................................................................................................................... 3320
Centroid ............................................................................................................................... 3321
CornerNodeCount ................................................................................................................ 3321
CornerNodeIds ..................................................................................................................... 3321
CornerNodes ........................................................................................................................ 3321
Dimension ............................................................................................................................ 3321
Id ......................................................................................................................................... 3321
NodeIds ................................................................................................................................ 3322
Nodes ................................................................................................................................... 3322
Type ..................................................................................................................................... 3322
Volume ................................................................................................................................. 3322
IMeshComputedData .................................................................................................................. 3322
ContactElementIds ............................................................................................................... 3323
ContactNodeIds .................................................................................................................... 3323
IMeshData .................................................................................................................................. 3323
ElementCount ...................................................................................................................... 3324
ElementIds ........................................................................................................................... 3324
Elements .............................................................................................................................. 3324
NodeCount ........................................................................................................................... 3324
NodeIds ................................................................................................................................ 3324
Nodes ................................................................................................................................... 3324
Unit ...................................................................................................................................... 3325
UseCache ............................................................................................................................. 3325
ElementById(int) ................................................................................................................... 3325
ElementIdsFromNodeIds(IEnumerable<int>) ......................................................................... 3325
MeshRegionById(int) ............................................................................................................. 3325
NodeById(int) ....................................................................................................................... 3326
NodeIdsFromElementIds(IEnumerable<int>) ......................................................................... 3326
IMeshRegion .............................................................................................................................. 3326
ElementCount ...................................................................................................................... 3327
ElementIds ........................................................................................................................... 3327
Elements .............................................................................................................................. 3327
NodeCount ........................................................................................................................... 3327
NodeIds ................................................................................................................................ 3327
Nodes ................................................................................................................................... 3327
INode ......................................................................................................................................... 3328
BodyIds ................................................................................................................................ 3328
ConnectedElementIds ........................................................................................................... 3328
ConnectedElements .............................................................................................................. 3328
GeoEntityIds ......................................................................................................................... 3329
Id ......................................................................................................................................... 3329
X .......................................................................................................................................... 3329

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

Y .......................................................................................................................................... 3329
Z .......................................................................................................................................... 3329
Ansys.ACT.Interfaces.Graphics Namespace .................................................................................... 3331
IBodyView .................................................................................................................................. 3331
Name ................................................................................................................................... 3332
Selection .............................................................................................................................. 3332
ICamera ...................................................................................................................................... 3332
ZoomFactor .......................................................................................................................... 3332
GetLocation() ........................................................................................................................ 3332
GetTarget() ........................................................................................................................... 3333
ICamera2 .................................................................................................................................... 3333
Location ............................................................................................................................... 3333
PerspectViewAngle ............................................................................................................... 3333
RotationalCenter ................................................................................................................... 3333
Target ................................................................................................................................... 3334
UpVector .............................................................................................................................. 3334
ZoomShift ............................................................................................................................ 3334
IDraw2DContext ......................................................................................................................... 3334
Clear() ................................................................................................................................... 3335
DrawText2D(IPoint, string) ..................................................................................................... 3335
DrawText2D(int, int, string) .................................................................................................... 3335
LineTo2D(IPoint) ................................................................................................................... 3335
LineTo2D(int, int) ................................................................................................................... 3336
MoveTo2D(IPoint) ................................................................................................................. 3336
MoveTo2D(int, int) ................................................................................................................ 3336
IDraw3DContext ......................................................................................................................... 3337
Close() .................................................................................................................................. 3337
DrawCircle(IEnumerable<double>, double, IEnumerable<double>) ....................................... 3337
DrawDisc(IEnumerable<double>, double, IEnumerable<double>) ......................................... 3338
DrawPoints(IEnumerable<double>) ...................................................................................... 3338
DrawPoints(IEnumerable<double>, double) .......................................................................... 3338
DrawPolygon(IEnumerable<double>, IEnumerable<double>) ............................................... 3339
DrawPolyline(IEnumerable<double>, bool) ........................................................................... 3339
DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ....................... 3339
DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumer-
able<int>) ............................................................................................................................ 3340
SetTransformation(double[]) ................................................................................................. 3340
IDrawContext ............................................................................................................................. 3341
Color .................................................................................................................................... 3341
DepthTest ............................................................................................................................. 3341
LineWeight ........................................................................................................................... 3341
Translucency ......................................................................................................................... 3342
Visible .................................................................................................................................. 3342
IFactory2D .................................................................................................................................. 3342
CreatePolyline() .................................................................................................................... 3342
CreatePolyline(IEnumerable<IPoint>) .................................................................................... 3342
CreateText() .......................................................................................................................... 3343
CreateText(IPoint, string) ....................................................................................................... 3343
IFactory3D .................................................................................................................................. 3343
CreateArrow(double) ............................................................................................................ 3344
CreateArrow(double, double, double, double) ........................................................................ 3345
CreateBox(double, double, double) ........................................................................................ 3345

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

CreateCircle(double) ............................................................................................................. 3346


CreateCone(double, double) ................................................................................................. 3346
CreateCone(double, double, double) ..................................................................................... 3346
CreateCylinder(double, double) ............................................................................................. 3347
CreateDisc(double) ............................................................................................................... 3347
CreateGeometry(IGeoEntity) ................................................................................................. 3347
CreateMesh(IElement) ........................................................................................................... 3347
CreateMesh(IEnumerable<IElement>) ................................................................................... 3348
CreateMesh(IMeshData) ........................................................................................................ 3348
CreateMesh(IMeshRegion) .................................................................................................... 3348
CreateNodeBox(IEnumerable<INode>) ................................................................................. 3348
CreateNodeBox(INode) ......................................................................................................... 3349
CreateNodeBox(IEnumerable<INode>, double) ..................................................................... 3349
CreateNodeBox(INode, double) ............................................................................................. 3349
CreatePoint() ........................................................................................................................ 3350
CreatePoint(IEnumerable<IWorldPoint>, double) ................................................................... 3350
CreatePoint(IWorldPoint, double) .......................................................................................... 3350
CreatePolyline() .................................................................................................................... 3350
CreatePolyline(IEnumerable<IWorldPoint>) ........................................................................... 3351
CreateQuad(double, double) ................................................................................................. 3351
CreateShell() ......................................................................................................................... 3351
CreateShell(IGeoTessellation, IEnumerable<int>) ................................................................... 3351
CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ..................... 3352
CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumer-
able<int>) ............................................................................................................................ 3352
CreateSphere(double) ........................................................................................................... 3353
CreateTriad(double) .............................................................................................................. 3353
IGraphics .................................................................................................................................... 3353
Camera ................................................................................................................................. 3354
Scene ................................................................................................................................... 3354
Unit ...................................................................................................................................... 3354
CreatePixelPoint(int, int) ........................................................................................................ 3354
CreateVector3D(double, double, double) ............................................................................... 3355
CreateWorldPoint(double, double, double) ............................................................................ 3355
ExportScreenToImage(string) ................................................................................................ 3355
ForceResume() ...................................................................................................................... 3356
Redraw() ............................................................................................................................... 3356
Suspend() ............................................................................................................................. 3356
IGraphicsCollection ..................................................................................................................... 3356
Entities ................................................................................................................................. 3356
Factory2D ............................................................................................................................. 3357
Factory3D ............................................................................................................................. 3357
Clear() ................................................................................................................................... 3357
CreateChildCollection() ......................................................................................................... 3357
Remove(IGraphicsCollection) ................................................................................................ 3357
Remove(IGraphicsEntity) ....................................................................................................... 3358
IPixelPoint .................................................................................................................................. 3358
X .......................................................................................................................................... 3358
Y .......................................................................................................................................... 3358
Set(int, int) ............................................................................................................................ 3358
IPoint .......................................................................................................................................... 3359
Changed ............................................................................................................................... 3359

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

Clone() ................................................................................................................................. 3359


ToPixelPoint() ........................................................................................................................ 3359
ToWorldPoint() ...................................................................................................................... 3360
ISuspendController ..................................................................................................................... 3360
Resume() .............................................................................................................................. 3360
ITransformable ............................................................................................................................ 3360
Transformation3D ................................................................................................................. 3361
ITransformation3D ...................................................................................................................... 3361
Item(int, int) .......................................................................................................................... 3361
Scale ..................................................................................................................................... 3362
Reset() .................................................................................................................................. 3362
Rotate(IVector3D, double) ..................................................................................................... 3362
Set(double[]) ........................................................................................................................ 3362
Set(IWorldPoint) ................................................................................................................... 3363
Set(IWorldPoint, IVector3D) ................................................................................................... 3363
Set(IWorldPoint, IVector3D, IVector3D) ................................................................................... 3363
Set(IWorldPoint, IVector3D, IVector3D, IVector3D) ................................................................... 3364
ToArray() ............................................................................................................................... 3364
Translate(IVector3D) .............................................................................................................. 3364
Translate(double, double, double) .......................................................................................... 3364
IVector3D ................................................................................................................................... 3365
X .......................................................................................................................................... 3365
Y .......................................................................................................................................... 3365
Z .......................................................................................................................................... 3366
CrossProduct(IVector3D) ....................................................................................................... 3366
GetNormal() .......................................................................................................................... 3366
IsColinearTo(IVector3D) ......................................................................................................... 3366
IsColinearTo(IVector3D, double) ............................................................................................. 3367
Length() ............................................................................................................................... 3367
Normalize() ........................................................................................................................... 3367
SquareLength() ..................................................................................................................... 3367
IWorldPoint ................................................................................................................................ 3367
X .......................................................................................................................................... 3368
Y .......................................................................................................................................... 3368
Z .......................................................................................................................................... 3368
Ansys.ACT.Interfaces.Graphics.Entities Namespace ...................................................................... 3369
IArrow3D .................................................................................................................................... 3369
Body ..................................................................................................................................... 3370
BodyLength .......................................................................................................................... 3370
BodyRadius .......................................................................................................................... 3370
Head .................................................................................................................................... 3370
HeadLength .......................................................................................................................... 3370
HeadRadius .......................................................................................................................... 3371
Length .................................................................................................................................. 3371
IBox3D ........................................................................................................................................ 3371
X .......................................................................................................................................... 3371
Y .......................................................................................................................................... 3371
Z .......................................................................................................................................... 3372
ICircle3D ..................................................................................................................................... 3372
Radius .................................................................................................................................. 3372
ICone3D ..................................................................................................................................... 3372
BottomRadius ....................................................................................................................... 3373

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

Closed .................................................................................................................................. 3373


Length .................................................................................................................................. 3373
Samples ................................................................................................................................ 3373
TopRadius ............................................................................................................................. 3373
IDisc3D ....................................................................................................................................... 3373
Radius .................................................................................................................................. 3374
IGeometry3D .............................................................................................................................. 3374
DisplayEdge .......................................................................................................................... 3374
DisplayFace .......................................................................................................................... 3375
DisplayVertex ........................................................................................................................ 3375
EdgeColor ............................................................................................................................. 3375
FaceColor ............................................................................................................................. 3375
VertexColor ........................................................................................................................... 3375
VertexSize ............................................................................................................................. 3375
IGraphicsEntity ........................................................................................................................... 3376
Color .................................................................................................................................... 3376
DepthTest ............................................................................................................................. 3376
Is2D ...................................................................................................................................... 3376
Is3D ...................................................................................................................................... 3377
LineWeight ........................................................................................................................... 3377
Name ................................................................................................................................... 3377
Translucency ......................................................................................................................... 3377
Visible .................................................................................................................................. 3377
Delete() ................................................................................................................................ 3377
IMesh3D ..................................................................................................................................... 3378
INodeBox3D ............................................................................................................................... 3378
Size ...................................................................................................................................... 3378
IPoint3D ..................................................................................................................................... 3378
Points ................................................................................................................................... 3379
Size ...................................................................................................................................... 3379
IPolyline<T> ............................................................................................................................... 3379
Closed .................................................................................................................................. 3379
EndPoint ............................................................................................................................... 3379
Length .................................................................................................................................. 3380
Points ................................................................................................................................... 3380
StartPoint ............................................................................................................................. 3380
IQuad3D ..................................................................................................................................... 3380
X .......................................................................................................................................... 3380
Y .......................................................................................................................................... 3381
IShell3D ...................................................................................................................................... 3381
Colors ................................................................................................................................... 3381
Connectivity ......................................................................................................................... 3381
HasColors ............................................................................................................................. 3382
Initialized .............................................................................................................................. 3382
Normals ................................................................................................................................ 3382
TriangleCount ....................................................................................................................... 3382
Vertices ................................................................................................................................ 3382
SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ................... 3382
SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumer-
able<int>) ............................................................................................................................ 3383
ISphere3D .................................................................................................................................. 3383
Radius .................................................................................................................................. 3384

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

Samples ................................................................................................................................ 3384


IText2D ....................................................................................................................................... 3384
Origin ................................................................................................................................... 3384
Text ...................................................................................................................................... 3385
ITriad3D ...................................................................................................................................... 3385
Length .................................................................................................................................. 3385
XArrow ................................................................................................................................. 3385
YArrow ................................................................................................................................. 3385
ZArrow ................................................................................................................................. 3386
Ansys.ACT.Interfaces.Geometry Namespace .................................................................................. 3387
GeoBodyTypeEnum .................................................................................................................... 3387
GeoCellTypeEnum ...................................................................................................................... 3388
GeoCurveTypeEnum ................................................................................................................... 3388
GeoSurfaceTypeEnum ................................................................................................................ 3389
IBaseGeoBody ............................................................................................................................ 3389
Area ..................................................................................................................................... 3390
BodyType ............................................................................................................................. 3390
Centroid ............................................................................................................................... 3390
Edges ................................................................................................................................... 3390
Faces .................................................................................................................................... 3391
Length .................................................................................................................................. 3391
Vertices ................................................................................................................................ 3391
Volume ................................................................................................................................. 3391
IBaseGeoBodyOrPart ................................................................................................................... 3391
IBaseGeoEdge ............................................................................................................................. 3391
Bodies .................................................................................................................................. 3392
Centroid ............................................................................................................................... 3392
CurveType ............................................................................................................................ 3392
EndVertex ............................................................................................................................. 3392
Faces .................................................................................................................................... 3393
Length .................................................................................................................................. 3393
StartVertex ........................................................................................................................... 3393
Vertices ................................................................................................................................ 3393
IBaseGeoEntity ........................................................................................................................... 3393
Id ......................................................................................................................................... 3394
Type ..................................................................................................................................... 3394
GetBoundingBox() ................................................................................................................ 3394
IBaseGeoFace ............................................................................................................................. 3394
Area ..................................................................................................................................... 3395
Bodies .................................................................................................................................. 3395
Centroid ............................................................................................................................... 3395
Edges ................................................................................................................................... 3395
SurfaceType .......................................................................................................................... 3395
Vertices ................................................................................................................................ 3396
NormalAtParam(double, double) ........................................................................................... 3396
NormalsAtParams(double[]) .................................................................................................. 3396
ParamAtPoint(double[]) ........................................................................................................ 3396
PointAtParam(double, double) .............................................................................................. 3397
PointsAtParams(double[]) ..................................................................................................... 3397
IBaseGeoPart .............................................................................................................................. 3397
Bodies .................................................................................................................................. 3397
Name ................................................................................................................................... 3398

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

IBaseGeoVertex .......................................................................................................................... 3398


Bodies .................................................................................................................................. 3398
Edges ................................................................................................................................... 3398
Faces .................................................................................................................................... 3399
X .......................................................................................................................................... 3399
Y .......................................................................................................................................... 3399
Z .......................................................................................................................................... 3399
IGeoAssembly ............................................................................................................................. 3399
Dimension ............................................................................................................................ 3400
Name ................................................................................................................................... 3400
Parts ..................................................................................................................................... 3400
Unit ...................................................................................................................................... 3400
IGeoBody ................................................................................................................................... 3400
CrossSection ......................................................................................................................... 3401
CrossSectionOffset ................................................................................................................ 3401
CrossSectionOffsetType ........................................................................................................ 3401
Material ................................................................................................................................ 3401
Name ................................................................................................................................... 3401
Shells .................................................................................................................................... 3401
Suppressed ........................................................................................................................... 3402
Thickness .............................................................................................................................. 3402
IGeoData .................................................................................................................................... 3402
Assemblies ........................................................................................................................... 3402
GeoEntityById(int) ................................................................................................................ 3402
IGeoEdge .................................................................................................................................... 3403
CrossSectionOrientation ....................................................................................................... 3403
Extents ................................................................................................................................. 3403
IsParamReversed ................................................................................................................... 3403
ParamAtPoint(double[]) ........................................................................................................ 3404
PointAtParam(double) .......................................................................................................... 3404
PointsAtParams(double[]) ..................................................................................................... 3404
TangentAtParam(double) ...................................................................................................... 3404
TangentsAtParams(double[]) ................................................................................................. 3405
IGeoEntity .................................................................................................................................. 3405
GeoData ............................................................................................................................... 3405
Part ...................................................................................................................................... 3405
IGeoFace .................................................................................................................................... 3406
Loops ................................................................................................................................... 3406
Shell ..................................................................................................................................... 3406
IGeoLoop ................................................................................................................................... 3406
Edges ................................................................................................................................... 3407
Face ...................................................................................................................................... 3407
IGeoPart ..................................................................................................................................... 3407
IGeoShell .................................................................................................................................... 3407
Faces .................................................................................................................................... 3407
IGeoTessellation .......................................................................................................................... 3407
FacetCount ........................................................................................................................... 3408
Indices .................................................................................................................................. 3408
Normals ................................................................................................................................ 3408
Points ................................................................................................................................... 3408
IGeoVertex .................................................................................................................................. 3408
MaterialTypeEnum ...................................................................................................................... 3409

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

Ansys.ACT.Interfaces.DataModel Namespace ................................................................................ 3411


IDataModelObject ...................................................................................................................... 3411
ObjectLocation ..................................................................................................................... 3411
ObjectType ........................................................................................................................... 3411
Parent ................................................................................................................................... 3412
SupportedLocations ............................................................................................................. 3412
Ansys.ACT.Interfaces.Common Namespace ................................................................................... 3413
AngleUnitType ............................................................................................................................ 3413
AngularVelocityUnitType ............................................................................................................ 3414
IAttributeCollection .................................................................................................................... 3414
Item(string) .......................................................................................................................... 3414
Keys ..................................................................................................................................... 3415
Contains(string) .................................................................................................................... 3415
GetStringValue(string) ........................................................................................................... 3415
GetValue(string) .................................................................................................................... 3415
GetValue(string, object) ......................................................................................................... 3416
Remove(string) ..................................................................................................................... 3416
SetValue(string, object) ......................................................................................................... 3416
IBreakpoint ................................................................................................................................. 3417
IsEnabled .............................................................................................................................. 3417
Line ...................................................................................................................................... 3417
SourceFile ............................................................................................................................. 3417
IExtension ................................................................................................................................... 3417
Attributes ............................................................................................................................. 3418
InstallDir ............................................................................................................................... 3418
MinorVersion ........................................................................................................................ 3418
Name ................................................................................................................................... 3418
UniqueId .............................................................................................................................. 3419
Version ................................................................................................................................. 3419
IExtensionManager ..................................................................................................................... 3419
CurrentExtension .................................................................................................................. 3419
Extensions ............................................................................................................................ 3419
ILog ............................................................................................................................................ 3420
WriteError(string) .................................................................................................................. 3420
WriteMessage(string) ............................................................................................................ 3420
WriteWarning(string) ............................................................................................................ 3420
IParameter .................................................................................................................................. 3421
Key ....................................................................................................................................... 3421
Name ................................................................................................................................... 3421
Value .................................................................................................................................... 3421
IParameterManager .................................................................................................................... 3422
IProcessUtilities ........................................................................................................................... 3422
Start(string, params string[]) .................................................................................................. 3422
Start(string, bool, params string[]) .......................................................................................... 3422
ISelectionInfo ............................................................................................................................. 3423
Id ......................................................................................................................................... 3423
Ids ........................................................................................................................................ 3423
Name ................................................................................................................................... 3423
SelectionType ....................................................................................................................... 3424
ISelectionManager ...................................................................................................................... 3424
CurrentSelection ................................................................................................................... 3424
AddSelection(ISelectionInfo) ................................................................................................. 3424

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

ClearSelection() .................................................................................................................... 3425


CreateSelectionInfo(SelectionTypeEnum) .............................................................................. 3425
NewSelection(ISelectionInfo) ................................................................................................ 3425
ISourceFile .................................................................................................................................. 3425
Content ................................................................................................................................ 3426
FilePath ................................................................................................................................ 3426
Save() ................................................................................................................................... 3426
ITools .......................................................................................................................................... 3426
GetGeoDataFromFile(string) ................................................................................................. 3427
GetMeshDataFromFile(string, string) ..................................................................................... 3427
GetResultsDataFromFile(string) ............................................................................................. 3427
IWorksheet ................................................................................................................................. 3427
RowCount ............................................................................................................................ 3428
AddRow() ............................................................................................................................. 3428
DeleteRow(int) ...................................................................................................................... 3428
MechanicalUnitSystemEnum ....................................................................................................... 3428
MetricTemperatureUnitType ....................................................................................................... 3429
SelectionTypeEnum .................................................................................................................... 3429
State ........................................................................................................................................... 3430
StateMessageTypes .................................................................................................................... 3430
UserErrorMessageException ........................................................................................................ 3431
Ansys.ACT.Interfaces.Analysis Namespace ..................................................................................... 3433
CoordinateSystemTypeEnum ...................................................................................................... 3433
IAnalysis ..................................................................................................................................... 3433
AnalysisType ......................................................................................................................... 3435
CoordinateSystems ............................................................................................................... 3435
GeoData ............................................................................................................................... 3435
Id ......................................................................................................................................... 3436
MeshData ............................................................................................................................. 3436
Name ................................................................................................................................... 3436
PhysicsType .......................................................................................................................... 3436
PropertyNames ..................................................................................................................... 3436
Solver ................................................................................................................................... 3436
SolverName .......................................................................................................................... 3437
StepsEndTime ....................................................................................................................... 3437
WorkingDir ........................................................................................................................... 3437
CoordinateSystemById(int) .................................................................................................... 3437
CreateLoadObject(string, IExtension) ..................................................................................... 3437
CreateLoadObject(string, string) ............................................................................................ 3438
CreatePostObject(string, IExtension) ...................................................................................... 3438
CreatePostObject(string, string) ............................................................................................. 3438
CreateResultObject(string, IExtension) ................................................................................... 3439
CreateResultObject(string, string) .......................................................................................... 3439
CurrentConsistentUnitFromQuantityName(string) ................................................................. 3439
GenerateMesh() .................................................................................................................... 3440
GetLoadObjects(IExtension) .................................................................................................. 3440
GetLoadObjects(string) ......................................................................................................... 3440
GetResultObjects(IExtension) ................................................................................................ 3440
GetResultObjects(string) ....................................................................................................... 3441
GetResultsData() ................................................................................................................... 3441
GetUserObjects(IExtension) .................................................................................................. 3441
GetUserObjects(string) .......................................................................................................... 3441

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

PropertyValue(string) ............................................................................................................ 3442


PropertyValue(string, object) ................................................................................................. 3442
Solve(bool) ........................................................................................................................... 3442
Solve(bool, string) ................................................................................................................. 3442
WriteInputFile(string) ............................................................................................................ 3443
ICoordinateSystem ..................................................................................................................... 3443
CoordinateSystemType ......................................................................................................... 3443
Id ......................................................................................................................................... 3444
Matrix ................................................................................................................................... 3444
Name ................................................................................................................................... 3444
Origin ................................................................................................................................... 3444
XAxis .................................................................................................................................... 3444
YAxis ..................................................................................................................................... 3444
ZAxis .................................................................................................................................... 3445
IDataObject ................................................................................................................................ 3445
Id ......................................................................................................................................... 3445
Name ................................................................................................................................... 3445
PropertyNames ..................................................................................................................... 3446
Type ..................................................................................................................................... 3446
PropertyValue(string) ............................................................................................................ 3446
PropertyValue(string, object) ................................................................................................. 3446
IDataObjectCollection ................................................................................................................. 3446
Ids ........................................................................................................................................ 3447
List ....................................................................................................................................... 3447
Names .................................................................................................................................. 3447
GetById(int) .......................................................................................................................... 3447
GetByName(string) ............................................................................................................... 3448
GetEnumerator() ................................................................................................................... 3448
NamesByType(string) ............................................................................................................ 3448
IDataObjectContainer ................................................................................................................. 3448
DataObjects .......................................................................................................................... 3449
ISolverData ................................................................................................................................. 3449
CurrentStep .......................................................................................................................... 3450
MaxElementId ...................................................................................................................... 3450
MaxElementType .................................................................................................................. 3450
MaxNodeId ........................................................................................................................... 3450
SolveType ............................................................................................................................. 3450
GetContactId(int) .................................................................................................................. 3450
GetContactTargetId(int) ........................................................................................................ 3451
GetCoordinateSystemSolverId(int) ........................................................................................ 3451
GetMaterialSolverId(int) ........................................................................................................ 3451
GetNewElementId() .............................................................................................................. 3452
GetNewElementType() .......................................................................................................... 3452
GetNewNodeId() ................................................................................................................... 3452
GetRemotePointNodeId(int) .................................................................................................. 3452
SolveTypeEnum .......................................................................................................................... 3452
Ansys.DesignXplorer.API Namespace ............................................................................................ 3455
ParameterNature ........................................................................................................................ 3455
Ansys.DesignXplorer.API.Optimization Namespace ...................................................................... 3457
DXConvergenceData ................................................................................................................... 3458
DXConvergenceDescription ........................................................................................................ 3458
DXOptimizationPoint .................................................................................................................. 3458

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

enumAllowedContinuousValues ................................................................................................. 3458


enumConstraintHandlingType .................................................................................................... 3458
enumConstraintType .................................................................................................................. 3459
enumCurveType ......................................................................................................................... 3459
enumGoalType ........................................................................................................................... 3459
enumPostProcessingType ........................................................................................................... 3459
IConvergenceData ...................................................................................................................... 3459
get_Value(int, out Int32, out Double, out Boolean) ................................................................. 3460
put_Value(int, int, double, bool) ............................................................................................. 3460
IConvergenceDescription ............................................................................................................ 3461
IndexOfCurvesSupportingFeasibility ..................................................................................... 3461
NumberOfFeasibleCurves ..................................................................................................... 3461
NumberOfGroups ................................................................................................................. 3462
Quantity ............................................................................................................................... 3462
Unit ...................................................................................................................................... 3462
XAxisLabel ............................................................................................................................ 3462
YAxisLabel ............................................................................................................................ 3462
AddCurve(int, string, enumCurveType, bool) .......................................................................... 3462
AddGroup(string) .................................................................................................................. 3463
get_CurveLabel(int) .............................................................................................................. 3463
get_CurveType(int) ............................................................................................................... 3463
get_GroupLabel(int) ............................................................................................................. 3464
get_NumberOfCurves(int) ..................................................................................................... 3464
IGridSupport ............................................................................................................................... 3464
AddGridInterval(string, double) ............................................................................................. 3464
IOptimizationMethod ................................................................................................................. 3465
Candidates ........................................................................................................................... 3466
PostProcessingTypes ............................................................................................................. 3466
Samples ................................................................................................................................ 3466
Services ................................................................................................................................ 3466
AddConstraint(string, enumConstraintType, object, object, double, bool) ................................ 3467
AddCustomConstraintProperty(string, string, object) ............................................................. 3467
AddCustomObjectiveProperty(string, string, object) .............................................................. 3468
AddCustomVariableProperty(string, string, object) ................................................................. 3468
AddDoubleListVariable(string, IListCpp, double) ..................................................................... 3468
AddDoubleVariable(string, double, double, double) ............................................................... 3469
AddIntegerListVariable(string, IListCpp, int) ............................................................................ 3469
AddObjective(string, enumGoalType, double, double) ............................................................ 3470
AddOutput(string) ................................................................................................................ 3470
AddParameterRelationship(string, string, string, enumParameterRelationshipType) ................ 3470
CanRun(out String) ............................................................................................................... 3471
get_Setting(string) ................................................................................................................ 3471
put_Setting(string, object) .................................................................................................... 3471
Run() .................................................................................................................................... 3472
IOptimizationPoint ...................................................................................................................... 3472
Feasible ................................................................................................................................ 3472
ID ......................................................................................................................................... 3473
ParetoFrontIndex .................................................................................................................. 3473
State ..................................................................................................................................... 3473
StateMessage ....................................................................................................................... 3473
get_Value(string) .................................................................................................................. 3473
put_Value(string, object) ....................................................................................................... 3473

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

IOptimizationServices ................................................................................................................. 3474


ExistingPoints ....................................................................................................................... 3475
Stopped ............................................................................................................................... 3475
CalculateParameterRelationshipsFromPoint(IPoint) ............................................................... 3476
CalculateParameterRelationshipsFromPoints(IListCpp) .......................................................... 3476
CalculatePoint(IPoint) ............................................................................................................ 3476
CalculatePoints(IListCpp) ...................................................................................................... 3476
PublishLogMessage(string) ................................................................................................... 3477
PublishProgress(string, int) .................................................................................................... 3477
PushConvergenceData(IConvergenceData) ........................................................................... 3477
PushHistoryPoint(IOptimizationPoint) ................................................................................... 3478
PushHistoryPoints(IListCpp) .................................................................................................. 3478
IUserOptimizer ............................................................................................................................ 3478
BasedOnDirectOptimizationOnly .......................................................................................... 3482
BasedOnResponseSurfaceOnly ............................................................................................. 3482
ConstraintHandling ............................................................................................................... 3482
ConstraintImportance ........................................................................................................... 3482
ConstraintOnInputParameter ................................................................................................ 3482
ConvergenceData ................................................................................................................. 3482
EqualToConstraint ................................................................................................................ 3483
EqualToConstraintDefined .................................................................................................... 3483
GreaterThanConstraint .......................................................................................................... 3483
GreaterThanConstraintDefined ............................................................................................. 3483
HistoryChartXAxisType ......................................................................................................... 3483
InsideBoundsConstraint ........................................................................................................ 3484
InsideBoundsConstraintDefined ............................................................................................ 3484
IsDirectOptimization ............................................................................................................. 3484
LessThanConstraint ............................................................................................................... 3484
LessThanConstraintDefined .................................................................................................. 3484
LogFile ................................................................................................................................. 3484
MaximizeObjective ............................................................................................................... 3485
MaximizeObjectiveDefined ................................................................................................... 3485
MaximumNumberOfConstraints ........................................................................................... 3485
MaximumNumberOfDoubleListParameters ........................................................................... 3485
MaximumNumberOfDoubleParameters ................................................................................ 3485
MaximumNumberOfInputParameters ................................................................................... 3486
MaximumNumberOfIntegerListParameters ........................................................................... 3486
MaximumNumberOfObjectives ............................................................................................. 3486
MinimizeObjective ................................................................................................................ 3486
MinimizeObjectiveDefined .................................................................................................... 3486
MinimumNumberOfConstraints ............................................................................................ 3486
MinimumNumberOfObjectives ............................................................................................. 3487
NumberOfConstraintsDefined ............................................................................................... 3487
NumberOfConstraintsDefinedOnInputs ................................................................................ 3487
NumberOfDoubleListParametersDefined .............................................................................. 3487
NumberOfDoubleParametersDefined .................................................................................... 3487
NumberOfInputParametersDefined ....................................................................................... 3487
NumberOfIntegerListParametersDefined ............................................................................... 3488
NumberOfObjectivesDefined ................................................................................................ 3488
NumberOfObjectivesDefinedOnInputs .................................................................................. 3488
ObjectiveImportance ............................................................................................................ 3488
ObjectiveOnInputParameter ................................................................................................. 3488

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

ParameterRelationship .......................................................................................................... 3489


SeekObjective ....................................................................................................................... 3489
SeekObjectiveDefined .......................................................................................................... 3489
StartingPointRequired .......................................................................................................... 3489
Ansys.DesignXplorer.API.Sampling Namespace ............................................................................ 3491
IUserSampling ............................................................................................................................ 3491
LogFile ................................................................................................................................. 3492
MaximumNumberOfDoubleListParameters ........................................................................... 3492
MaximumNumberOfDoubleParameters ................................................................................ 3492
MaximumNumberOfInputParameters ................................................................................... 3493
MaximumNumberOfIntegerListParameters ........................................................................... 3493
NumberOfDoubleListParametersDefined .............................................................................. 3493
NumberOfDoubleParametersDefined .................................................................................... 3493
NumberOfInputParametersDefined ....................................................................................... 3493
NumberOfIntegerListParametersDefined ............................................................................... 3493
Ansys.DesignXplorer.API.Common Namespace ............................................................................. 3495
enumDistributionType ................................................................................................................ 3495
enumParameterRelationshipType ............................................................................................... 3495
enumPointState .......................................................................................................................... 3496
enumSimulationType .................................................................................................................. 3496
IMethod ..................................................................................................................................... 3496
AddDoubleListVariable(string, IListCpp, double) ..................................................................... 3497
AddDoubleVariable(string, double, double, double) ............................................................... 3497
AddIntegerListVariable(string, IListCpp, int) ............................................................................ 3497
AddOutput(string) ................................................................................................................ 3498
AddParameterRelationship(string, string, string, enumParameterRelationshipType) ................ 3498
CanRun(out String) ............................................................................................................... 3499
get_Setting(string) ................................................................................................................ 3499
put_Setting(string, object) .................................................................................................... 3499
Run() .................................................................................................................................... 3499
IPoint .......................................................................................................................................... 3500
ID ......................................................................................................................................... 3500
State ..................................................................................................................................... 3500
StateMessage ....................................................................................................................... 3500
get_Value(string) .................................................................................................................. 3501
put_Value(string, object) ....................................................................................................... 3501
IServices ..................................................................................................................................... 3501
ExistingPoints ....................................................................................................................... 3502
Stopped ............................................................................................................................... 3503
CalculateParameterRelationshipsFromPoint(IPoint) ............................................................... 3503
CalculateParameterRelationshipsFromPoints(IListCpp) .......................................................... 3503
CalculatePoint(IPoint) ............................................................................................................ 3503
CalculatePoints(IListCpp) ...................................................................................................... 3504
PublishLogMessage(string) ................................................................................................... 3504
PublishProgress(string, int) .................................................................................................... 3504
IUserExtensionOptimizationCriterion .......................................................................................... 3505
IUserExtensionParameter ............................................................................................................ 3505
Ansys.DesignXplorer.Automation Namespace .............................................................................. 3507
CustomConstraintProperties ....................................................................................................... 3507
DisplayText ........................................................................................................................... 3508
CustomObjectiveProperties ........................................................................................................ 3508
DisplayText ........................................................................................................................... 3508

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

CustomParameterProperties ....................................................................................................... 3508


DisplayText ........................................................................................................................... 3508
DiscreteLevel .............................................................................................................................. 3509
DisplayText ........................................................................................................................... 3509
Index .................................................................................................................................... 3509
Value .................................................................................................................................... 3509
HistoryChart ............................................................................................................................... 3509
DisplayParameterFullName ................................................................................................... 3510
DisplayText ........................................................................................................................... 3510
IsUpToDate ........................................................................................................................... 3510
InputParameter ........................................................................................................................... 3510
Attribute1 ............................................................................................................................. 3512
Attribute2 ............................................................................................................................. 3512
ConstantValue ...................................................................................................................... 3512
CustomDefinitionList ............................................................................................................ 3512
DiscreteLevels ....................................................................................................................... 3512
DisplayText ........................................................................................................................... 3512
DistributionLowerBound ....................................................................................................... 3513
DistributionType ................................................................................................................... 3513
DistributionUpperBound ...................................................................................................... 3513
Enabled ................................................................................................................................ 3513
Kurtosis ................................................................................................................................ 3513
LowerBound ......................................................................................................................... 3513
Mean .................................................................................................................................... 3514
Nature .................................................................................................................................. 3514
NumberOfLevels ................................................................................................................... 3514
Skewness .............................................................................................................................. 3514
StandardDeviation ................................................................................................................ 3514
Type ..................................................................................................................................... 3514
Units .................................................................................................................................... 3515
UpperBound ......................................................................................................................... 3515
UseManufacturableValues ..................................................................................................... 3515
OptimizationCriterion ................................................................................................................. 3515
AllowedValues ...................................................................................................................... 3516
ConstraintFirstValue .............................................................................................................. 3516
ConstraintHandling ............................................................................................................... 3516
ConstraintImportance ........................................................................................................... 3517
ConstraintSecondValue ......................................................................................................... 3517
ConstraintType ..................................................................................................................... 3517
CustomConstraintDefinitionList ............................................................................................ 3517
CustomObjectiveDefinitionList ............................................................................................. 3517
DisplayText ........................................................................................................................... 3517
GridInterval .......................................................................................................................... 3518
HistoryChart ......................................................................................................................... 3518
LowerBound ......................................................................................................................... 3518
ObjectiveImportance ............................................................................................................ 3518
ObjectiveTargetValue ............................................................................................................ 3518
ObjectiveType ...................................................................................................................... 3518
StartingValue ........................................................................................................................ 3519
Units .................................................................................................................................... 3519
UpperBound ......................................................................................................................... 3519
Ansys.ACT.WorkBench.Schematic Namespace ............................................................................... 3521

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

UserTask ..................................................................................................................................... 3521


ActiveDirectory ..................................................................................................................... 3522
Component .......................................................................................................................... 3522
EditIcon ................................................................................................................................ 3522
InputData ............................................................................................................................. 3523
InternalObject ...................................................................................................................... 3523
OutputData .......................................................................................................................... 3523
Parameters ........................................................................................................................... 3523
Properties ............................................................................................................................. 3523
RegisteredFiles ..................................................................................................................... 3523
SourceTasks .......................................................................................................................... 3524
TargetTasks ........................................................................................................................... 3524
TaskGroup ............................................................................................................................ 3524
TaskState .............................................................................................................................. 3524
Template .............................................................................................................................. 3524
TransferData ......................................................................................................................... 3524
Type ..................................................................................................................................... 3525
Edit( params object[]) ............................................................................................................ 3525
ExecuteCommand(string, IDictionary<string, object>) ........................................................... 3525
Exit( params object[]) ............................................................................................................ 3525
RegisterFile(string) ................................................................................................................ 3526
Send( params object[]) .......................................................................................................... 3526
SignalModified() ................................................................................................................... 3526
SignalOutputsGenerated() .................................................................................................... 3526
UnregisterFile(DataReference) ............................................................................................... 3526
UnregisterFile(string) ............................................................................................................ 3527
UnregisterFile(DataReference, bool) ....................................................................................... 3527
UnregisterFile(string, bool) .................................................................................................... 3527
UserTaskGroup ........................................................................................................................... 3528
Abbreviation ......................................................................................................................... 3528
Caption ................................................................................................................................ 3528
Category .............................................................................................................................. 3528
HeaderText ........................................................................................................................... 3529
InternalObject ...................................................................................................................... 3529
IsParametricGroup ................................................................................................................ 3529
Name ................................................................................................................................... 3529
Tasks .................................................................................................................................... 3529
Template .............................................................................................................................. 3529
UserTaskGroupTemplate ............................................................................................................. 3530
Abbreviation ......................................................................................................................... 3530
Caption ................................................................................................................................ 3530
Category .............................................................................................................................. 3530
HeaderText ........................................................................................................................... 3531
InternalObject ...................................................................................................................... 3531
IsParametricGroup ................................................................................................................ 3531
Name ................................................................................................................................... 3531
UserTaskTemplate ....................................................................................................................... 3531
InternalObject ...................................................................................................................... 3531
Ansys.ACT.WorkBench.Automation.Workflows Namespace .......................................................... 3533
Parameter ................................................................................................................................... 3533
Caption ................................................................................................................................ 3533
InternalObject ...................................................................................................................... 3534

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

Name ................................................................................................................................... 3534


Usage ................................................................................................................................... 3534
Value .................................................................................................................................... 3534
Property ..................................................................................................................................... 3534
Name ................................................................................................................................... 3534
Value .................................................................................................................................... 3535
Task ............................................................................................................................................ 3535
ActiveDirectory ..................................................................................................................... 3536
AlwaysIncludeInDPUpdate .................................................................................................... 3537
Caption ................................................................................................................................ 3537
Container ............................................................................................................................. 3537
CoordinateId ........................................................................................................................ 3537
CoupledClients ..................................................................................................................... 3537
CoupledToTask ..................................................................................................................... 3537
DirectoryName ..................................................................................................................... 3538
ImageName .......................................................................................................................... 3538
InputData ............................................................................................................................. 3538
InternalObject ...................................................................................................................... 3538
IsFailedState ......................................................................................................................... 3538
IsSharing .............................................................................................................................. 3538
MasterTask ........................................................................................................................... 3539
Name ................................................................................................................................... 3539
Notes .................................................................................................................................... 3539
OutputData .......................................................................................................................... 3539
Parameters ........................................................................................................................... 3539
Properties ............................................................................................................................. 3539
RealTask ............................................................................................................................... 3540
Solver ................................................................................................................................... 3540
SourceTasks .......................................................................................................................... 3540
State ..................................................................................................................................... 3540
TargetTasks ........................................................................................................................... 3540
TaskGroup ............................................................................................................................ 3540
TaskId ................................................................................................................................... 3541
Template .............................................................................................................................. 3541
UsedLicenses ........................................................................................................................ 3541
UserId ................................................................................................................................... 3541
UserTask ............................................................................................................................... 3541
Clean() .................................................................................................................................. 3541
ExecuteCommand(string, IDictionary<string, object>) ........................................................... 3542
GetPropertyNames() ............................................................................................................. 3542
Refresh() ............................................................................................................................... 3542
Remove() .............................................................................................................................. 3542
Reset() .................................................................................................................................. 3542
Update() ............................................................................................................................... 3543
TaskGroup .................................................................................................................................. 3543
Abbreviation ......................................................................................................................... 3544
AnalysisType ......................................................................................................................... 3544
Caption ................................................................................................................................ 3544
DirectoryName ..................................................................................................................... 3544
HeaderText ........................................................................................................................... 3544
InternalObject ...................................................................................................................... 3545
IsParametric .......................................................................................................................... 3545

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

Name ................................................................................................................................... 3545


Notes .................................................................................................................................... 3545
Physics ................................................................................................................................. 3545
Solver ................................................................................................................................... 3545
TaskGroupId ......................................................................................................................... 3546
Tasks .................................................................................................................................... 3546
Template .............................................................................................................................. 3546
Clean() .................................................................................................................................. 3546
Copy() .................................................................................................................................. 3546
Delete() ................................................................................................................................ 3546
GetTaskById(string) ............................................................................................................... 3547
RecreateDeletedTasks() ......................................................................................................... 3547
Refresh() ............................................................................................................................... 3547
Update() ............................................................................................................................... 3547
TaskGroupTemplate .................................................................................................................... 3547
AnalysisType ......................................................................................................................... 3549
Attributes ............................................................................................................................. 3549
Category .............................................................................................................................. 3549
DisplayName ........................................................................................................................ 3549
ExcludedTaskTemplates ........................................................................................................ 3549
HeaderText ........................................................................................................................... 3550
ImageName .......................................................................................................................... 3550
InternalObject ...................................................................................................................... 3550
IsBeta ................................................................................................................................... 3550
IsDeletable ........................................................................................................................... 3550
IsParametric .......................................................................................................................... 3550
Name ................................................................................................................................... 3551
Physics ................................................................................................................................. 3551
PostCreationSteps ................................................................................................................. 3551
RequiredTaskTemplates ........................................................................................................ 3551
Solver ................................................................................................................................... 3551
TaskGroupHelpId .................................................................................................................. 3551
TaskGroupType ..................................................................................................................... 3552
TaskGroupTypeAbbreviation ................................................................................................. 3552
TaskNames ........................................................................................................................... 3552
TaskTemplates ...................................................................................................................... 3552
ToolboxGroup ....................................................................................................................... 3552
ToolTipHelpId ....................................................................................................................... 3552
ToolTipText ........................................................................................................................... 3553
Visible .................................................................................................................................. 3553
TaskTemplate .............................................................................................................................. 3553
AboutToResetCommandName .............................................................................................. 3557
AvailableTransferTasks .......................................................................................................... 3557
CanDuplicateQueryName ..................................................................................................... 3557
CanUseTransferDataQueryName ........................................................................................... 3558
CleanCommandName ........................................................................................................... 3558
ComponentImageName ....................................................................................................... 3558
ComponentPropertyDataQueryName ................................................................................... 3558
CreateAllProvidesConnectionsToNewSystem ......................................................................... 3558
CreatingCommandName ...................................................................................................... 3558
DataGroupStatusQueryName ................................................................................................ 3559
DataGroupUpdateCommandName ....................................................................................... 3559

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

DataSourceListChangedCommandName .............................................................................. 3559


DefaultTransferName ............................................................................................................ 3559
DeletingCommandName ...................................................................................................... 3559
DesignPointReportContentCreationCommandName ............................................................. 3559
DisplayName ........................................................................................................................ 3560
DontShareByDefault ............................................................................................................. 3560
DuplicateGroup .................................................................................................................... 3560
DuplicateTaskCommandName .............................................................................................. 3560
EditorInitiatedRemoteUpdateInfoQueryName ....................................................................... 3560
EquivalentInputs ................................................................................................................... 3560
GetEnvironmentForRsmDpUpdateQueryName ...................................................................... 3561
GetRemoteUpdateMonitorFilesQueryName .......................................................................... 3561
IncludeInPartialUpdate ......................................................................................................... 3561
InternalObject ...................................................................................................................... 3561
IsAim .................................................................................................................................... 3561
IsDeletable ........................................................................................................................... 3561
IsDisabled ............................................................................................................................. 3562
IsReplaceable ........................................................................................................................ 3562
IsReplaceableWithSharing ..................................................................................................... 3562
IsResults ............................................................................................................................... 3562
IsShareable ........................................................................................................................... 3562
Name ................................................................................................................................... 3563
OutputTypes ......................................................................................................................... 3563
RefreshAfterPartialUpdate ..................................................................................................... 3563
RefreshCommandName ........................................................................................................ 3563
RemoteSolvePermissionsQueryName .................................................................................... 3563
ReportContentCreationCommandName ............................................................................... 3563
RequiredInputTypes .............................................................................................................. 3564
ResetCommandName ........................................................................................................... 3564
ShowOptionToAlwaysBePartOfDpUpdate ............................................................................. 3564
Solver ................................................................................................................................... 3564
SubTasks ............................................................................................................................... 3564
SubTaskStatusQueryName .................................................................................................... 3564
TaskStatusQueryName .......................................................................................................... 3565
TaskTypeAbbreviation ........................................................................................................... 3565
UpdateCommandName ........................................................................................................ 3565
ValidationCodes .................................................................................................................... 3565
WillBePendingUponUpdateQueryName ................................................................................ 3565
WillBeUpdatedViaRsmQueryName ........................................................................................ 3565

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cc 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 ............................................................................................................................................... 14
14. Members ............................................................................................................................................... 15
15. Members ............................................................................................................................................... 15
16. Members ............................................................................................................................................... 17
17. Members ............................................................................................................................................... 18
18. Members ............................................................................................................................................... 20
19. Members ............................................................................................................................................... 22
20. Members ............................................................................................................................................... 25
21. Members ............................................................................................................................................... 25
22. Members ............................................................................................................................................... 27
23. Members ............................................................................................................................................... 28
24. Members ............................................................................................................................................... 30
25. Members ............................................................................................................................................... 33
26. Members ............................................................................................................................................... 35
27. Members ............................................................................................................................................... 35
28. Members ............................................................................................................................................... 41
29. Members ............................................................................................................................................... 41
30. Members ............................................................................................................................................... 44
31. Members ............................................................................................................................................... 44
32. Members ............................................................................................................................................... 45
33. Members ............................................................................................................................................... 46
34. Members ............................................................................................................................................... 47
35. Members ............................................................................................................................................... 49
36. Members ............................................................................................................................................... 50
37. Members ............................................................................................................................................... 52
38. Members ............................................................................................................................................... 52
39. Members ............................................................................................................................................... 53
40. Members ............................................................................................................................................... 54
41. Members ............................................................................................................................................... 55
42. Members ............................................................................................................................................... 56
43. Members ............................................................................................................................................... 56
44. Members ............................................................................................................................................... 58
45. Members ............................................................................................................................................... 63
46. Members ............................................................................................................................................... 64
47. Members ............................................................................................................................................... 66
48. Members ............................................................................................................................................... 67
49. Members ............................................................................................................................................... 68
50. Members ............................................................................................................................................... 69

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

51. Members ............................................................................................................................................... 70


52. Members ............................................................................................................................................... 71
53. Members ............................................................................................................................................... 71
54. Members ............................................................................................................................................... 72
55. Members ............................................................................................................................................... 73
56. Members ............................................................................................................................................... 74
57. Members ............................................................................................................................................... 76
58. Members ............................................................................................................................................... 76
59. Members ............................................................................................................................................... 77
60. Members ............................................................................................................................................... 77
61. Members ............................................................................................................................................... 79
62. Members ............................................................................................................................................... 79
63. Members ............................................................................................................................................... 81
64. Members ............................................................................................................................................... 81
65. Members ............................................................................................................................................... 85
66. Members ............................................................................................................................................... 85
67. Members ............................................................................................................................................... 87
68. Members ............................................................................................................................................... 89
69. Members ............................................................................................................................................... 89
70. Members ............................................................................................................................................... 90
71. Members ............................................................................................................................................... 91
72. Members ............................................................................................................................................... 94
73. Members ............................................................................................................................................... 95
74. Members ............................................................................................................................................... 95
75. Members ............................................................................................................................................... 96
76. Members ............................................................................................................................................... 97
77. Members ............................................................................................................................................... 98
78. Members ............................................................................................................................................. 101
79. Members ............................................................................................................................................. 101
80. Members ............................................................................................................................................. 102
81. Members ............................................................................................................................................. 103
82. Members ............................................................................................................................................. 104
83. Members ............................................................................................................................................. 107
84. Members ............................................................................................................................................. 108
85. Members ............................................................................................................................................. 109
86. Members ............................................................................................................................................. 110
87. Members ............................................................................................................................................. 111
88. Members ............................................................................................................................................. 112
89. Members ............................................................................................................................................. 115
90. Members ............................................................................................................................................. 117
91. Members ............................................................................................................................................. 117
92. Members ............................................................................................................................................. 121
93. Members ............................................................................................................................................. 122
94. Members ............................................................................................................................................. 124
95. Members ............................................................................................................................................. 127
96. Members ............................................................................................................................................. 133
97. Members ............................................................................................................................................. 133
98. Members ............................................................................................................................................. 134
99. Members ............................................................................................................................................. 135
100. Members ........................................................................................................................................... 136
101. Members ........................................................................................................................................... 139
102. Members ........................................................................................................................................... 143

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

103. Members ........................................................................................................................................... 147


104. Members ........................................................................................................................................... 149
105. Members ........................................................................................................................................... 179
106. Members ........................................................................................................................................... 183
107. Members ........................................................................................................................................... 187
108. Members ........................................................................................................................................... 193
109. Members ........................................................................................................................................... 209
110. Members ........................................................................................................................................... 211
111. Members ........................................................................................................................................... 216
112. Members ........................................................................................................................................... 216
113. Members ........................................................................................................................................... 224
114. Members ........................................................................................................................................... 226
115. Members ........................................................................................................................................... 227
116. Members ........................................................................................................................................... 229
117. Members ........................................................................................................................................... 231
118. Members ........................................................................................................................................... 233
119. Members ........................................................................................................................................... 237
120. Members ........................................................................................................................................... 245
121. Members ........................................................................................................................................... 246
122. Members ........................................................................................................................................... 249
123. Members ........................................................................................................................................... 253
124. Members ........................................................................................................................................... 256
125. Members ........................................................................................................................................... 258
126. Members ........................................................................................................................................... 260
127. Members ........................................................................................................................................... 263
128. Members ........................................................................................................................................... 274
129. Members ........................................................................................................................................... 277
130. Members ........................................................................................................................................... 282
131. Members ........................................................................................................................................... 286
132. Members ........................................................................................................................................... 288
133. Members ........................................................................................................................................... 291
134. Members ........................................................................................................................................... 294
135. Members ........................................................................................................................................... 296
136. Members ........................................................................................................................................... 297
137. Members ........................................................................................................................................... 299
138. Members ........................................................................................................................................... 301
139. Members ........................................................................................................................................... 305
140. Members ........................................................................................................................................... 311
141. Members ........................................................................................................................................... 312
142. Members ........................................................................................................................................... 318
143. Members ........................................................................................................................................... 323
144. Members ........................................................................................................................................... 326
145. Members ........................................................................................................................................... 327
146. Members ........................................................................................................................................... 336
147. Members ........................................................................................................................................... 338
148. Members ........................................................................................................................................... 343
149. Members ........................................................................................................................................... 347
150. Members ........................................................................................................................................... 350
151. Members ........................................................................................................................................... 354
152. Members ........................................................................................................................................... 357
153. Members ........................................................................................................................................... 373
154. Members ........................................................................................................................................... 375

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

155. Members ........................................................................................................................................... 377


156. Members ........................................................................................................................................... 378
157. Members ........................................................................................................................................... 380
158. Members ........................................................................................................................................... 381
159. Members ........................................................................................................................................... 382
160. Members ........................................................................................................................................... 383
161. Members ........................................................................................................................................... 384
162. Members ........................................................................................................................................... 385
163. Members ........................................................................................................................................... 387
164. Members ........................................................................................................................................... 388
165. Members ........................................................................................................................................... 390
166. Members ........................................................................................................................................... 391
167. Members ........................................................................................................................................... 392
168. Members ........................................................................................................................................... 393
169. Members ........................................................................................................................................... 394
170. Members ........................................................................................................................................... 395
171. Members ........................................................................................................................................... 396
172. Members ........................................................................................................................................... 408
173. Members ........................................................................................................................................... 412
174. Members ........................................................................................................................................... 416
175. Members ........................................................................................................................................... 424
176. Members ........................................................................................................................................... 430
177. Members ........................................................................................................................................... 434
178. Members ........................................................................................................................................... 436
179. Members ........................................................................................................................................... 438
180. Members ........................................................................................................................................... 440
181. Members ........................................................................................................................................... 443
182. Members ........................................................................................................................................... 448
183. Members ........................................................................................................................................... 451
184. Members ........................................................................................................................................... 456
185. Members ........................................................................................................................................... 457
186. Members ........................................................................................................................................... 460
187. Members ........................................................................................................................................... 466
188. Members ........................................................................................................................................... 469
189. Members ........................................................................................................................................... 472
190. Members ........................................................................................................................................... 478
191. Members ........................................................................................................................................... 482
192. Members ........................................................................................................................................... 499
193. Members ........................................................................................................................................... 500
194. Members ........................................................................................................................................... 507
195. Members ........................................................................................................................................... 510
196. Members ........................................................................................................................................... 513
197. Members ........................................................................................................................................... 517
198. Members ........................................................................................................................................... 520
199. Members ........................................................................................................................................... 521
200. Members ........................................................................................................................................... 526
201. Members ........................................................................................................................................... 529
202. Members ........................................................................................................................................... 533
203. Members ........................................................................................................................................... 538
204. Members ........................................................................................................................................... 541
205. Members ........................................................................................................................................... 550
206. Members ........................................................................................................................................... 552

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

207. Members ........................................................................................................................................... 554


208. Members ........................................................................................................................................... 563
209. Members ........................................................................................................................................... 569
210. Members ........................................................................................................................................... 573
211. Members ........................................................................................................................................... 579
212. Members ........................................................................................................................................... 581
213. Members ........................................................................................................................................... 587
214. Members ........................................................................................................................................... 590
215. Members ........................................................................................................................................... 594
216. Members ........................................................................................................................................... 596
217. Members ........................................................................................................................................... 597
218. Members ........................................................................................................................................... 600
219. Members ........................................................................................................................................... 602
220. Members ........................................................................................................................................... 605
221. Members ........................................................................................................................................... 611
222. Members ........................................................................................................................................... 613
223. Members ........................................................................................................................................... 615
224. Members ........................................................................................................................................... 622
225. Members ........................................................................................................................................... 625
226. Members ........................................................................................................................................... 628
227. Members ........................................................................................................................................... 632
228. Members ........................................................................................................................................... 643
229. Members ........................................................................................................................................... 650
230. Members ........................................................................................................................................... 655
231. Members ........................................................................................................................................... 659
232. Members ........................................................................................................................................... 721
233. Members ........................................................................................................................................... 736
234. Members ........................................................................................................................................... 744
235. Members ........................................................................................................................................... 765
236. Members ........................................................................................................................................... 770
237. Members ........................................................................................................................................... 774
238. Members ........................................................................................................................................... 778
239. Members ........................................................................................................................................... 783
240. Members ........................................................................................................................................... 787
241. Members ........................................................................................................................................... 789
242. Members ........................................................................................................................................... 791
243. Members ........................................................................................................................................... 793
244. Members ........................................................................................................................................... 795
245. Members ........................................................................................................................................... 800
246. Members ........................................................................................................................................... 806
247. Members ........................................................................................................................................... 808
248. Members ........................................................................................................................................... 812
249. Members ........................................................................................................................................... 819
250. Members ........................................................................................................................................... 823
251. Members ........................................................................................................................................... 823
252. Members ........................................................................................................................................... 837
253. Members ........................................................................................................................................... 839
254. Members ........................................................................................................................................... 841
255. Members ........................................................................................................................................... 845
256. Members ........................................................................................................................................... 847
257. Members ........................................................................................................................................... 870
258. Members ........................................................................................................................................... 873

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

259. Members ........................................................................................................................................... 875


260. Members ........................................................................................................................................... 876
261. Members ........................................................................................................................................... 878
262. Members ........................................................................................................................................... 883
263. Members ........................................................................................................................................... 884
264. Members ........................................................................................................................................... 887
265. Members ........................................................................................................................................... 890
266. Members ........................................................................................................................................... 894
267. Members ........................................................................................................................................... 896
268. Members ........................................................................................................................................... 898
269. Members ........................................................................................................................................... 901
270. Members ........................................................................................................................................... 905
271. Members ........................................................................................................................................... 909
272. Members ........................................................................................................................................... 912
273. Members ........................................................................................................................................... 916
274. Members ........................................................................................................................................... 929
275. Members ........................................................................................................................................... 940
276. Members ........................................................................................................................................... 943
277. Members ........................................................................................................................................... 946
278. Members ........................................................................................................................................... 950
279. Members ........................................................................................................................................... 951
280. Members ........................................................................................................................................... 954
281. Members ........................................................................................................................................... 956
282. Members ........................................................................................................................................... 963
283. Members ........................................................................................................................................... 976
284. Members ........................................................................................................................................... 979
285. Members ........................................................................................................................................... 985
286. Members ........................................................................................................................................... 985
287. Members ........................................................................................................................................... 989
288. Members ........................................................................................................................................... 992
289. Members ........................................................................................................................................... 995
290. Members ........................................................................................................................................... 998
291. Members ......................................................................................................................................... 1003
292. Members ......................................................................................................................................... 1004
293. Members ......................................................................................................................................... 1008
294. Members ......................................................................................................................................... 1013
295. Members ......................................................................................................................................... 1017
296. Members ......................................................................................................................................... 1022
297. Members ......................................................................................................................................... 1026
298. Members ......................................................................................................................................... 1031
299. Members ......................................................................................................................................... 1035
300. Members ......................................................................................................................................... 1040
301. Members ......................................................................................................................................... 1044
302. Members ......................................................................................................................................... 1049
303. Members ......................................................................................................................................... 1053
304. Members ......................................................................................................................................... 1058
305. Members ......................................................................................................................................... 1063
306. Members ......................................................................................................................................... 1067
307. Members ......................................................................................................................................... 1072
308. Members ......................................................................................................................................... 1076
309. Members ......................................................................................................................................... 1081
310. Members ......................................................................................................................................... 1086

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

311. Members ......................................................................................................................................... 1093


312. Members ......................................................................................................................................... 1099
313. Members ......................................................................................................................................... 1099
314. Members ......................................................................................................................................... 1107
315. Members ......................................................................................................................................... 1112
316. Members ......................................................................................................................................... 1117
317. Members ......................................................................................................................................... 1122
318. Members ......................................................................................................................................... 1127
319. Members ......................................................................................................................................... 1132
320. Members ......................................................................................................................................... 1138
321. Members ......................................................................................................................................... 1143
322. Members ......................................................................................................................................... 1148
323. Members ......................................................................................................................................... 1153
324. Members ......................................................................................................................................... 1158
325. Members ......................................................................................................................................... 1163
326. Members ......................................................................................................................................... 1163
327. Members ......................................................................................................................................... 1168
328. Members ......................................................................................................................................... 1171
329. Members ......................................................................................................................................... 1175
330. Members ......................................................................................................................................... 1179
331. Members ......................................................................................................................................... 1183
332. Members ......................................................................................................................................... 1187
333. Members ......................................................................................................................................... 1191
334. Members ......................................................................................................................................... 1194
335. Members ......................................................................................................................................... 1198
336. Members ......................................................................................................................................... 1202
337. Members ......................................................................................................................................... 1206
338. Members ......................................................................................................................................... 1210
339. Members ......................................................................................................................................... 1214
340. Members ......................................................................................................................................... 1217
341. Members ......................................................................................................................................... 1223
342. Members ......................................................................................................................................... 1223
343. Members ......................................................................................................................................... 1229
344. Members ......................................................................................................................................... 1233
345. Members ......................................................................................................................................... 1238
346. Members ......................................................................................................................................... 1242
347. Members ......................................................................................................................................... 1247
348. Members ......................................................................................................................................... 1251
349. Members ......................................................................................................................................... 1255
350. Members ......................................................................................................................................... 1260
351. Members ......................................................................................................................................... 1265
352. Members ......................................................................................................................................... 1265
353. Members ......................................................................................................................................... 1269
354. Members ......................................................................................................................................... 1273
355. Members ......................................................................................................................................... 1277
356. Members ......................................................................................................................................... 1281
357. Members ......................................................................................................................................... 1285
358. Members ......................................................................................................................................... 1289
359. Members ......................................................................................................................................... 1293
360. Members ......................................................................................................................................... 1298
361. Members ......................................................................................................................................... 1302
362. Members ......................................................................................................................................... 1307

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

363. Members ......................................................................................................................................... 1307


364. Members ......................................................................................................................................... 1311
365. Members ......................................................................................................................................... 1315
366. Members ......................................................................................................................................... 1318
367. Members ......................................................................................................................................... 1324
368. Members ......................................................................................................................................... 1329
369. Members ......................................................................................................................................... 1329
370. Members ......................................................................................................................................... 1335
371. Members ......................................................................................................................................... 1340
372. Members ......................................................................................................................................... 1346
373. Members ......................................................................................................................................... 1352
374. Members ......................................................................................................................................... 1357
375. Members ......................................................................................................................................... 1363
376. Members ......................................................................................................................................... 1369
377. Members ......................................................................................................................................... 1374
378. Members ......................................................................................................................................... 1383
379. Members ......................................................................................................................................... 1383
380. Members ......................................................................................................................................... 1387
381. Members ......................................................................................................................................... 1391
382. Members ......................................................................................................................................... 1394
383. Members ......................................................................................................................................... 1398
384. Members ......................................................................................................................................... 1403
385. Members ......................................................................................................................................... 1403
386. Members ......................................................................................................................................... 1407
387. Members ......................................................................................................................................... 1411
388. Members ......................................................................................................................................... 1414
389. Members ......................................................................................................................................... 1418
390. Members ......................................................................................................................................... 1423
391. Members ......................................................................................................................................... 1423
392. Members ......................................................................................................................................... 1427
393. Members ......................................................................................................................................... 1431
394. Members ......................................................................................................................................... 1435
395. Members ......................................................................................................................................... 1439
396. Members ......................................................................................................................................... 1443
397. Members ......................................................................................................................................... 1444
398. Members ......................................................................................................................................... 1445
399. Members ......................................................................................................................................... 1449
400. Members ......................................................................................................................................... 1453
401. Members ......................................................................................................................................... 1457
402. Members ......................................................................................................................................... 1461
403. Members ......................................................................................................................................... 1465
404. Members ......................................................................................................................................... 1465
405. Members ......................................................................................................................................... 1469
406. Members ......................................................................................................................................... 1473
407. Members ......................................................................................................................................... 1477
408. Members ......................................................................................................................................... 1481
409. Members ......................................................................................................................................... 1485
410. Members ......................................................................................................................................... 1488
411. Members ......................................................................................................................................... 1493
412. Members ......................................................................................................................................... 1493
413. Members ......................................................................................................................................... 1497
414. Members ......................................................................................................................................... 1501

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

415. Members ......................................................................................................................................... 1504


416. Members ......................................................................................................................................... 1508
417. Members ......................................................................................................................................... 1512
418. Members ......................................................................................................................................... 1516
419. Members ......................................................................................................................................... 1519
420. Members ......................................................................................................................................... 1523
421. Members ......................................................................................................................................... 1527
422. Members ......................................................................................................................................... 1527
423. Members ......................................................................................................................................... 1531
424. Members ......................................................................................................................................... 1535
425. Members ......................................................................................................................................... 1538
426. Members ......................................................................................................................................... 1543
427. Members ......................................................................................................................................... 1543
428. Members ......................................................................................................................................... 1548
429. Members ......................................................................................................................................... 1552
430. Members ......................................................................................................................................... 1555
431. Members ......................................................................................................................................... 1559
432. Members ......................................................................................................................................... 1563
433. Members ......................................................................................................................................... 1567
434. Members ......................................................................................................................................... 1571
435. Members ......................................................................................................................................... 1571
436. Members ......................................................................................................................................... 1575
437. Members ......................................................................................................................................... 1579
438. Members ......................................................................................................................................... 1583
439. Members ......................................................................................................................................... 1587
440. Members ......................................................................................................................................... 1591
441. Members ......................................................................................................................................... 1595
442. Members ......................................................................................................................................... 1598
443. Members ......................................................................................................................................... 1602
444. Members ......................................................................................................................................... 1606
445. Members ......................................................................................................................................... 1610
446. Members ......................................................................................................................................... 1614
447. Members ......................................................................................................................................... 1617
448. Members ......................................................................................................................................... 1621
449. Members ......................................................................................................................................... 1625
450. Members ......................................................................................................................................... 1629
451. Members ......................................................................................................................................... 1630
452. Members ......................................................................................................................................... 1636
453. Members ......................................................................................................................................... 1641
454. Members ......................................................................................................................................... 1647
455. Members ......................................................................................................................................... 1653
456. Members ......................................................................................................................................... 1659
457. Members ......................................................................................................................................... 1665
458. Members ......................................................................................................................................... 1670
459. Members ......................................................................................................................................... 1676
460. Members ......................................................................................................................................... 1682
461. Members ......................................................................................................................................... 1688
462. Members ......................................................................................................................................... 1694
463. Members ......................................................................................................................................... 1699
464. Members ......................................................................................................................................... 1705
465. Members ......................................................................................................................................... 1711
466. Members ......................................................................................................................................... 1718

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

467. Members ......................................................................................................................................... 1724


468. Members ......................................................................................................................................... 1730
469. Members ......................................................................................................................................... 1737
470. Members ......................................................................................................................................... 1743
471. Members ......................................................................................................................................... 1753
472. Members ......................................................................................................................................... 1759
473. Members ......................................................................................................................................... 1765
474. Members ......................................................................................................................................... 1767
475. Members ......................................................................................................................................... 1773
476. Members ......................................................................................................................................... 1776
477. Members ......................................................................................................................................... 1779
478. Members ......................................................................................................................................... 1783
479. Members ......................................................................................................................................... 1786
480. Members ......................................................................................................................................... 1790
481. Members ......................................................................................................................................... 1793
482. Members ......................................................................................................................................... 1796
483. Members ......................................................................................................................................... 1800
484. Members ......................................................................................................................................... 1803
485. Members ......................................................................................................................................... 1807
486. Members ......................................................................................................................................... 1810
487. Members ......................................................................................................................................... 1813
488. Members ......................................................................................................................................... 1817
489. Members ......................................................................................................................................... 1820
490. Members ......................................................................................................................................... 1824
491. Members ......................................................................................................................................... 1827
492. Members ......................................................................................................................................... 1831
493. Members ......................................................................................................................................... 1834
494. Members ......................................................................................................................................... 1838
495. Members ......................................................................................................................................... 1841
496. Members ......................................................................................................................................... 1845
497. Members ......................................................................................................................................... 1848
498. Members ......................................................................................................................................... 1851
499. Members ......................................................................................................................................... 1855
500. Members ......................................................................................................................................... 1858
501. Members ......................................................................................................................................... 1862
502. Members ......................................................................................................................................... 1865
503. Members ......................................................................................................................................... 1869
504. Members ......................................................................................................................................... 1872
505. Members ......................................................................................................................................... 1875
506. Members ......................................................................................................................................... 1879
507. Members ......................................................................................................................................... 1882
508. Members ......................................................................................................................................... 1885
509. Members ......................................................................................................................................... 1889
510. Members ......................................................................................................................................... 1892
511. Members ......................................................................................................................................... 1895
512. Members ......................................................................................................................................... 1899
513. Members ......................................................................................................................................... 1903
514. Members ......................................................................................................................................... 1907
515. Members ......................................................................................................................................... 1911
516. Members ......................................................................................................................................... 1915
517. Members ......................................................................................................................................... 1919
518. Members ......................................................................................................................................... 1923

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

519. Members ......................................................................................................................................... 1926


520. Members ......................................................................................................................................... 1929
521. Members ......................................................................................................................................... 1933
522. Members ......................................................................................................................................... 1937
523. Members ......................................................................................................................................... 1940
524. Members ......................................................................................................................................... 1943
525. Members ......................................................................................................................................... 1946
526. Members ......................................................................................................................................... 1949
527. Members ......................................................................................................................................... 1953
528. Members ......................................................................................................................................... 1957
529. Members ......................................................................................................................................... 1961
530. Members ......................................................................................................................................... 1964
531. Members ......................................................................................................................................... 1967
532. Members ......................................................................................................................................... 1970
533. Members ......................................................................................................................................... 1973
534. Members ......................................................................................................................................... 1976
535. Members ......................................................................................................................................... 1980
536. Members ......................................................................................................................................... 1983
537. Members ......................................................................................................................................... 1987
538. Members ......................................................................................................................................... 1988
539. Members ......................................................................................................................................... 1991
540. Members ......................................................................................................................................... 1994
541. Members ......................................................................................................................................... 1997
542. Members ......................................................................................................................................... 2004
543. Members ......................................................................................................................................... 2012
544. Members ......................................................................................................................................... 2017
545. Members ......................................................................................................................................... 2021
546. Members ......................................................................................................................................... 2027
547. Members ......................................................................................................................................... 2030
548. Members ......................................................................................................................................... 2034
549. Members ......................................................................................................................................... 2037
550. Members ......................................................................................................................................... 2046
551. Members ......................................................................................................................................... 2050
552. Members ......................................................................................................................................... 2054
553. Members ......................................................................................................................................... 2060
554. Members ......................................................................................................................................... 2063
555. Members ......................................................................................................................................... 2066
556. Members ......................................................................................................................................... 2072
557. Members ......................................................................................................................................... 2076
558. Members ......................................................................................................................................... 2079
559. Members ......................................................................................................................................... 2083
560. Members ......................................................................................................................................... 2089
561. Members ......................................................................................................................................... 2092
562. Members ......................................................................................................................................... 2096
563. Members ......................................................................................................................................... 2099
564. Members ......................................................................................................................................... 2104
565. Members ......................................................................................................................................... 2115
566. Members ......................................................................................................................................... 2119
567. Members ......................................................................................................................................... 2125
568. Members ......................................................................................................................................... 2135
569. Members ......................................................................................................................................... 2145
570. Members ......................................................................................................................................... 2149

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

571. Members ......................................................................................................................................... 2152


572. Members ......................................................................................................................................... 2155
573. Members ......................................................................................................................................... 2161
574. Members ......................................................................................................................................... 2162
575. Members ......................................................................................................................................... 2165
576. Members ......................................................................................................................................... 2168
577. Members ......................................................................................................................................... 2171
578. Members ......................................................................................................................................... 2174
579. Members ......................................................................................................................................... 2177
580. Members ......................................................................................................................................... 2181
581. Members ......................................................................................................................................... 2184
582. Members ......................................................................................................................................... 2187
583. Members ......................................................................................................................................... 2190
584. Members ......................................................................................................................................... 2194
585. Members ......................................................................................................................................... 2199
586. Members ......................................................................................................................................... 2203
587. Members ......................................................................................................................................... 2207
588. Members ......................................................................................................................................... 2210
589. Members ......................................................................................................................................... 2215
590. Members ......................................................................................................................................... 2215
591. Members ......................................................................................................................................... 2219
592. Members ......................................................................................................................................... 2223
593. Members ......................................................................................................................................... 2226
594. Members ......................................................................................................................................... 2230
595. Members ......................................................................................................................................... 2238
596. Members ......................................................................................................................................... 2242
597. Members ......................................................................................................................................... 2246
598. Members ......................................................................................................................................... 2251
599. Members ......................................................................................................................................... 2251
600. Members ......................................................................................................................................... 2255
601. Members ......................................................................................................................................... 2259
602. Members ......................................................................................................................................... 2263
603. Members ......................................................................................................................................... 2267
604. Members ......................................................................................................................................... 2271
605. Members ......................................................................................................................................... 2275
606. Members ......................................................................................................................................... 2279
607. Members ......................................................................................................................................... 2283
608. Members ......................................................................................................................................... 2287
609. Members ......................................................................................................................................... 2293
610. Members ......................................................................................................................................... 2294
611. Members ......................................................................................................................................... 2299
612. Members ......................................................................................................................................... 2303
613. Members ......................................................................................................................................... 2308
614. Members ......................................................................................................................................... 2312
615. Members ......................................................................................................................................... 2322
616. Members ......................................................................................................................................... 2328
617. Members ......................................................................................................................................... 2334
618. Members ......................................................................................................................................... 2338
619. Members ......................................................................................................................................... 2342
620. Members ......................................................................................................................................... 2346
621. Members ......................................................................................................................................... 2351
622. Members ......................................................................................................................................... 2355

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

623. Members ......................................................................................................................................... 2360


624. Members ......................................................................................................................................... 2365
625. Members ......................................................................................................................................... 2369
626. Members ......................................................................................................................................... 2373
627. Members ......................................................................................................................................... 2379
628. Members ......................................................................................................................................... 2379
629. Members ......................................................................................................................................... 2380
630. Members ......................................................................................................................................... 2381
631. Members ......................................................................................................................................... 2383
632. Members ......................................................................................................................................... 2384
633. Members ......................................................................................................................................... 2385
634. Members ......................................................................................................................................... 2386
635. Members ......................................................................................................................................... 2391
636. Members ......................................................................................................................................... 2399
637. Members ......................................................................................................................................... 2400
638. Members ......................................................................................................................................... 2401
639. Members ......................................................................................................................................... 2403
640. Members ......................................................................................................................................... 2405
641. Members ......................................................................................................................................... 2405
642. Members ......................................................................................................................................... 2406
643. Members ......................................................................................................................................... 2407
644. Members ......................................................................................................................................... 2409
645. Members ......................................................................................................................................... 2409
646. Members ......................................................................................................................................... 2411
647. Members ......................................................................................................................................... 2411
648. Members ......................................................................................................................................... 2412
649. Members ......................................................................................................................................... 2413
650. Members ......................................................................................................................................... 2414
651. Members ......................................................................................................................................... 2415
652. Members ......................................................................................................................................... 2416
653. Members ......................................................................................................................................... 2417
654. Members ......................................................................................................................................... 2418
655. Members ......................................................................................................................................... 2419
656. Members ......................................................................................................................................... 2420
657. Members ......................................................................................................................................... 2421
658. Members ......................................................................................................................................... 2422
659. Members ......................................................................................................................................... 2424
660. Members ......................................................................................................................................... 2424
661. Members ......................................................................................................................................... 2425
662. Members ......................................................................................................................................... 2426
663. Members ......................................................................................................................................... 2427
664. Members ......................................................................................................................................... 2428
665. Members ......................................................................................................................................... 2429
666. Members ......................................................................................................................................... 2429
667. Members ......................................................................................................................................... 2431
668. Members ......................................................................................................................................... 2431
669. Members ......................................................................................................................................... 2433
670. Members ......................................................................................................................................... 2435
671. Members ......................................................................................................................................... 2436
672. Members ......................................................................................................................................... 2437
673. Members ......................................................................................................................................... 2438
674. Members ......................................................................................................................................... 2439

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

675. Members ......................................................................................................................................... 2440


676. Members ......................................................................................................................................... 2440
677. Members ......................................................................................................................................... 2441
678. Members ......................................................................................................................................... 2442
679. Members ......................................................................................................................................... 2443
680. Members ......................................................................................................................................... 2445
681. Members ......................................................................................................................................... 2447
682. Members ......................................................................................................................................... 2447
683. Members ......................................................................................................................................... 2448
684. Members ......................................................................................................................................... 2449
685. Members ......................................................................................................................................... 2449
686. Members ......................................................................................................................................... 2450
687. Members ......................................................................................................................................... 2451
688. Members ......................................................................................................................................... 2451
689. Members ......................................................................................................................................... 2461
690. Members ......................................................................................................................................... 2471
691. Members ......................................................................................................................................... 2477
692. Members ......................................................................................................................................... 2483
693. Members ......................................................................................................................................... 2492
694. Members ......................................................................................................................................... 2499
695. Members ......................................................................................................................................... 2521
696. Members ......................................................................................................................................... 2525
697. Members ......................................................................................................................................... 2541
698. Members ......................................................................................................................................... 2553
699. Members ......................................................................................................................................... 2556
700. Members ......................................................................................................................................... 2562
701. Members ......................................................................................................................................... 2563
702. Members ......................................................................................................................................... 2564
703. Members ......................................................................................................................................... 2569
704. Members ......................................................................................................................................... 2570
705. Members ......................................................................................................................................... 2571
706. Members ......................................................................................................................................... 2573
707. Members ......................................................................................................................................... 2575
708. Members ......................................................................................................................................... 2580
709. Members ......................................................................................................................................... 2582
710. Members ......................................................................................................................................... 2584
711. Members ......................................................................................................................................... 2586
712. Members ......................................................................................................................................... 2590
713. Members ......................................................................................................................................... 2591
714. Members ......................................................................................................................................... 2593
715. Members ......................................................................................................................................... 2594
716. Members ......................................................................................................................................... 2595
717. Members ......................................................................................................................................... 2598
718. Members ......................................................................................................................................... 2600
719. Members ......................................................................................................................................... 2601
720. Members ......................................................................................................................................... 2602
721. Members ......................................................................................................................................... 2607
722. Members ......................................................................................................................................... 2610
723. Members ......................................................................................................................................... 2614
724. Members ......................................................................................................................................... 2620
725. Members ......................................................................................................................................... 2621
726. Members ......................................................................................................................................... 2624

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

727. Members ......................................................................................................................................... 2626


728. Members ......................................................................................................................................... 2630
729. Members ......................................................................................................................................... 2634
730. Members ......................................................................................................................................... 2637
731. Members ......................................................................................................................................... 2639
732. Members ......................................................................................................................................... 2641
733. Members ......................................................................................................................................... 2643
734. Members ......................................................................................................................................... 2648
735. Members ......................................................................................................................................... 2653
736. Members ......................................................................................................................................... 2654
737. Members ......................................................................................................................................... 2656
738. Members ......................................................................................................................................... 2659
739. Members ......................................................................................................................................... 2662
740. Members ......................................................................................................................................... 2664
741. Members ......................................................................................................................................... 2665
742. Members ......................................................................................................................................... 2667
743. Members ......................................................................................................................................... 2672
744. Members ......................................................................................................................................... 2673
745. Members ......................................................................................................................................... 2678
746. Members ......................................................................................................................................... 2682
747. Members ......................................................................................................................................... 2684
748. Members ......................................................................................................................................... 2685
749. Members ......................................................................................................................................... 2689
750. Members ......................................................................................................................................... 2691
751. Members ......................................................................................................................................... 2692
752. Members ......................................................................................................................................... 2697
753. Members ......................................................................................................................................... 2700
754. Members ......................................................................................................................................... 2704
755. Members ......................................................................................................................................... 2709
756. Members ......................................................................................................................................... 2710
757. Members ......................................................................................................................................... 2711
758. Members ......................................................................................................................................... 2717
759. Members ......................................................................................................................................... 2720
760. Members ......................................................................................................................................... 2724
761. Members ......................................................................................................................................... 2727
762. Members ......................................................................................................................................... 2730
763. Members ......................................................................................................................................... 2732
764. Members ......................................................................................................................................... 2738
765. Members ......................................................................................................................................... 2740
766. Members ......................................................................................................................................... 2743
767. Members ......................................................................................................................................... 2746
768. Members ......................................................................................................................................... 2747
769. Members ......................................................................................................................................... 2752
770. Members ......................................................................................................................................... 2753
771. Members ......................................................................................................................................... 2755
772. Members ......................................................................................................................................... 2756
773. Members ......................................................................................................................................... 2760
774. Members ......................................................................................................................................... 2761
775. Members ......................................................................................................................................... 2764
776. Members ......................................................................................................................................... 2768
777. Members ......................................................................................................................................... 2774
778. Members ......................................................................................................................................... 2779

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

779. Members ......................................................................................................................................... 2782


780. Members ......................................................................................................................................... 2785
781. Members ......................................................................................................................................... 2789
782. Members ......................................................................................................................................... 2791
783. Members ......................................................................................................................................... 2792
784. Members ......................................................................................................................................... 2798
785. Members ......................................................................................................................................... 2799
786. Members ......................................................................................................................................... 2801
787. Members ......................................................................................................................................... 2804
788. Members ......................................................................................................................................... 2806
789. Members ......................................................................................................................................... 2809
790. Members ......................................................................................................................................... 2810
791. Members ......................................................................................................................................... 2813
792. Members ......................................................................................................................................... 2813
793. Members ......................................................................................................................................... 2817
794. Members ......................................................................................................................................... 2890
795. Members ......................................................................................................................................... 2919
796. Members ......................................................................................................................................... 2930
797. Members ......................................................................................................................................... 2935
798. Members ......................................................................................................................................... 2936
799. Members ......................................................................................................................................... 2945
800. Members ......................................................................................................................................... 2952
801. Members ......................................................................................................................................... 2958
802. Members ......................................................................................................................................... 2963
803. Members ......................................................................................................................................... 2967
804. Members ......................................................................................................................................... 2970
805. Members ......................................................................................................................................... 2970
806. Members ......................................................................................................................................... 2973
807. Members ......................................................................................................................................... 2979
808. Members ......................................................................................................................................... 2981
809. Members ......................................................................................................................................... 2982
810. Members ......................................................................................................................................... 2982
811. Members ......................................................................................................................................... 2983
812. Members ......................................................................................................................................... 2984
813. Members ......................................................................................................................................... 2984
814. Members ......................................................................................................................................... 2985
815. Members ......................................................................................................................................... 2986
816. Members ......................................................................................................................................... 2986
817. Members ......................................................................................................................................... 2986
818. Members ......................................................................................................................................... 2987
819. Members ......................................................................................................................................... 2988
820. Members ......................................................................................................................................... 2988
821. Members ......................................................................................................................................... 2991
822. Members ......................................................................................................................................... 2991
823. Members ......................................................................................................................................... 2993
824. Members ......................................................................................................................................... 2995
825. Members ......................................................................................................................................... 3007
826. Members ......................................................................................................................................... 3008
827. Members ......................................................................................................................................... 3008
828. Members ......................................................................................................................................... 3008
829. Members ......................................................................................................................................... 3008
830. Members ......................................................................................................................................... 3009

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

831. Members ......................................................................................................................................... 3009


832. Members ......................................................................................................................................... 3009
833. Members ......................................................................................................................................... 3010
834. Members ......................................................................................................................................... 3010
835. Members ......................................................................................................................................... 3010
836. Members ......................................................................................................................................... 3011
837. Members ......................................................................................................................................... 3011
838. Members ......................................................................................................................................... 3011
839. Members ......................................................................................................................................... 3011
840. Members ......................................................................................................................................... 3012
841. Members ......................................................................................................................................... 3012
842. Members ......................................................................................................................................... 3013
843. Members ......................................................................................................................................... 3013
844. Members ......................................................................................................................................... 3013
845. Members ......................................................................................................................................... 3013
846. Members ......................................................................................................................................... 3014
847. Members ......................................................................................................................................... 3014
848. Members ......................................................................................................................................... 3014
849. Members ......................................................................................................................................... 3015
850. Members ......................................................................................................................................... 3015
851. Members ......................................................................................................................................... 3015
852. Members ......................................................................................................................................... 3016
853. Members ......................................................................................................................................... 3016
854. Members ......................................................................................................................................... 3016
855. Members ......................................................................................................................................... 3017
856. Members ......................................................................................................................................... 3017
857. Members ......................................................................................................................................... 3017
858. Members ......................................................................................................................................... 3018
859. Members ......................................................................................................................................... 3018
860. Members ......................................................................................................................................... 3018
861. Members ......................................................................................................................................... 3018
862. Members ......................................................................................................................................... 3019
863. Members ......................................................................................................................................... 3019
864. Members ......................................................................................................................................... 3019
865. Members ......................................................................................................................................... 3020
866. Members ......................................................................................................................................... 3020
867. Members ......................................................................................................................................... 3020
868. Members ......................................................................................................................................... 3021
869. Members ......................................................................................................................................... 3021
870. Members ......................................................................................................................................... 3021
871. Members ......................................................................................................................................... 3022
872. Members ......................................................................................................................................... 3022
873. Members ......................................................................................................................................... 3022
874. Members ......................................................................................................................................... 3023
875. Members ......................................................................................................................................... 3023
876. Members ......................................................................................................................................... 3024
877. Members ......................................................................................................................................... 3024
878. Members ......................................................................................................................................... 3024
879. Members ......................................................................................................................................... 3025
880. Members ......................................................................................................................................... 3025
881. Members ......................................................................................................................................... 3025
882. Members ......................................................................................................................................... 3026

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

883. Members ......................................................................................................................................... 3026


884. Members ......................................................................................................................................... 3026
885. Members ......................................................................................................................................... 3026
886. Members ......................................................................................................................................... 3027
887. Members ......................................................................................................................................... 3027
888. Members ......................................................................................................................................... 3027
889. Members ......................................................................................................................................... 3028
890. Members ......................................................................................................................................... 3028
891. Members ......................................................................................................................................... 3028
892. Members ......................................................................................................................................... 3029
893. Members ......................................................................................................................................... 3029
894. Members ......................................................................................................................................... 3029
895. Members ......................................................................................................................................... 3030
896. Members ......................................................................................................................................... 3030
897. Members ......................................................................................................................................... 3030
898. Members ......................................................................................................................................... 3031
899. Members ......................................................................................................................................... 3031
900. Members ......................................................................................................................................... 3031
901. Members ......................................................................................................................................... 3032
902. Members ......................................................................................................................................... 3032
903. Members ......................................................................................................................................... 3032
904. Members ......................................................................................................................................... 3033
905. Members ......................................................................................................................................... 3033
906. Members ......................................................................................................................................... 3033
907. Members ......................................................................................................................................... 3034
908. Members ......................................................................................................................................... 3034
909. Members ......................................................................................................................................... 3034
910. Members ......................................................................................................................................... 3035
911. Members ......................................................................................................................................... 3035
912. Members ......................................................................................................................................... 3035
913. Members ......................................................................................................................................... 3036
914. Members ......................................................................................................................................... 3036
915. Members ......................................................................................................................................... 3036
916. Members ......................................................................................................................................... 3037
917. Members ......................................................................................................................................... 3037
918. Members ......................................................................................................................................... 3037
919. Members ......................................................................................................................................... 3038
920. Members ......................................................................................................................................... 3038
921. Members ......................................................................................................................................... 3038
922. Members ......................................................................................................................................... 3039
923. Members ......................................................................................................................................... 3039
924. Members ......................................................................................................................................... 3039
925. Members ......................................................................................................................................... 3040
926. Members ......................................................................................................................................... 3040
927. Members ......................................................................................................................................... 3040
928. Members ......................................................................................................................................... 3041
929. Members ......................................................................................................................................... 3041
930. Members ......................................................................................................................................... 3041
931. Members ......................................................................................................................................... 3041
932. Members ......................................................................................................................................... 3042
933. Members ......................................................................................................................................... 3042
934. Members ......................................................................................................................................... 3042

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

935. Members ......................................................................................................................................... 3042


936. Members ......................................................................................................................................... 3043
937. Members ......................................................................................................................................... 3043
938. Members ......................................................................................................................................... 3044
939. Members ......................................................................................................................................... 3059
940. Members ......................................................................................................................................... 3060
941. Members ......................................................................................................................................... 3060
942. Members ......................................................................................................................................... 3060
943. Members ......................................................................................................................................... 3061
944. Members ......................................................................................................................................... 3061
945. Members ......................................................................................................................................... 3061
946. Members ......................................................................................................................................... 3061
947. Members ......................................................................................................................................... 3062
948. Members ......................................................................................................................................... 3062
949. Members ......................................................................................................................................... 3062
950. Members ......................................................................................................................................... 3063
951. Members ......................................................................................................................................... 3063
952. Members ......................................................................................................................................... 3064
953. Members ......................................................................................................................................... 3064
954. Members ......................................................................................................................................... 3064
955. Members ......................................................................................................................................... 3065
956. Members ......................................................................................................................................... 3065
957. Members ......................................................................................................................................... 3065
958. Members ......................................................................................................................................... 3066
959. Members ......................................................................................................................................... 3066
960. Members ......................................................................................................................................... 3066
961. Members ......................................................................................................................................... 3067
962. Members ......................................................................................................................................... 3067
963. Members ......................................................................................................................................... 3067
964. Members ......................................................................................................................................... 3068
965. Members ......................................................................................................................................... 3068
966. Members ......................................................................................................................................... 3068
967. Members ......................................................................................................................................... 3068
968. Members ......................................................................................................................................... 3069
969. Members ......................................................................................................................................... 3069
970. Members ......................................................................................................................................... 3069
971. Members ......................................................................................................................................... 3070
972. Members ......................................................................................................................................... 3070
973. Members ......................................................................................................................................... 3070
974. Members ......................................................................................................................................... 3071
975. Members ......................................................................................................................................... 3071
976. Members ......................................................................................................................................... 3071
977. Members ......................................................................................................................................... 3072
978. Members ......................................................................................................................................... 3072
979. Members ......................................................................................................................................... 3072
980. Members ......................................................................................................................................... 3073
981. Members ......................................................................................................................................... 3073
982. Members ......................................................................................................................................... 3073
983. Members ......................................................................................................................................... 3074
984. Members ......................................................................................................................................... 3074
985. Members ......................................................................................................................................... 3074
986. Members ......................................................................................................................................... 3075

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

987. Members ......................................................................................................................................... 3075


988. Members ......................................................................................................................................... 3076
989. Members ......................................................................................................................................... 3076
990. Members ......................................................................................................................................... 3076
991. Members ......................................................................................................................................... 3077
992. Members ......................................................................................................................................... 3077
993. Members ......................................................................................................................................... 3077
994. Members ......................................................................................................................................... 3078
995. Members ......................................................................................................................................... 3078
996. Members ......................................................................................................................................... 3078
997. Members ......................................................................................................................................... 3079
998. Members ......................................................................................................................................... 3079
999. Members ......................................................................................................................................... 3079
1000. Members ....................................................................................................................................... 3080
1001. Members ....................................................................................................................................... 3080
1002. Members ....................................................................................................................................... 3080
1003. Members ....................................................................................................................................... 3080
1004. Members ....................................................................................................................................... 3081
1005. Members ....................................................................................................................................... 3081
1006. Members ....................................................................................................................................... 3081
1007. Members ....................................................................................................................................... 3082
1008. Members ....................................................................................................................................... 3082
1009. Members ....................................................................................................................................... 3082
1010. Members ....................................................................................................................................... 3083
1011. Members ....................................................................................................................................... 3083
1012. Members ....................................................................................................................................... 3084
1013. Members ....................................................................................................................................... 3084
1014. Members ....................................................................................................................................... 3084
1015. Members ....................................................................................................................................... 3084
1016. Members ....................................................................................................................................... 3085
1017. Members ....................................................................................................................................... 3085
1018. Members ....................................................................................................................................... 3085
1019. Members ....................................................................................................................................... 3086
1020. Members ....................................................................................................................................... 3086
1021. Members ....................................................................................................................................... 3086
1022. Members ....................................................................................................................................... 3087
1023. Members ....................................................................................................................................... 3087
1024. Members ....................................................................................................................................... 3087
1025. Members ....................................................................................................................................... 3087
1026. Members ....................................................................................................................................... 3088
1027. Members ....................................................................................................................................... 3088
1028. Members ....................................................................................................................................... 3088
1029. Members ....................................................................................................................................... 3089
1030. Members ....................................................................................................................................... 3089
1031. Members ....................................................................................................................................... 3090
1032. Members ....................................................................................................................................... 3090
1033. Members ....................................................................................................................................... 3090
1034. Members ....................................................................................................................................... 3091
1035. Members ....................................................................................................................................... 3091
1036. Members ....................................................................................................................................... 3092
1037. Members ....................................................................................................................................... 3092
1038. Members ....................................................................................................................................... 3092

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

1039. Members ....................................................................................................................................... 3093


1040. Members ....................................................................................................................................... 3093
1041. Members ....................................................................................................................................... 3093
1042. Members ....................................................................................................................................... 3094
1043. Members ....................................................................................................................................... 3094
1044. Members ....................................................................................................................................... 3094
1045. Members ....................................................................................................................................... 3095
1046. Members ....................................................................................................................................... 3095
1047. Members ....................................................................................................................................... 3096
1048. Members ....................................................................................................................................... 3096
1049. Members ....................................................................................................................................... 3096
1050. Members ....................................................................................................................................... 3096
1051. Members ....................................................................................................................................... 3097
1052. Members ....................................................................................................................................... 3097
1053. Members ....................................................................................................................................... 3097
1054. Members ....................................................................................................................................... 3098
1055. Members ....................................................................................................................................... 3098
1056. Members ....................................................................................................................................... 3099
1057. Members ....................................................................................................................................... 3099
1058. Members ....................................................................................................................................... 3099
1059. Members ....................................................................................................................................... 3100
1060. Members ....................................................................................................................................... 3100
1061. Members ....................................................................................................................................... 3100
1062. Members ....................................................................................................................................... 3101
1063. Members ....................................................................................................................................... 3101
1064. Members ....................................................................................................................................... 3101
1065. Members ....................................................................................................................................... 3102
1066. Members ....................................................................................................................................... 3102
1067. Members ....................................................................................................................................... 3102
1068. Members ....................................................................................................................................... 3102
1069. Members ....................................................................................................................................... 3103
1070. Members ....................................................................................................................................... 3104
1071. Members ....................................................................................................................................... 3104
1072. Members ....................................................................................................................................... 3105
1073. Members ....................................................................................................................................... 3105
1074. Members ....................................................................................................................................... 3105
1075. Members ....................................................................................................................................... 3106
1076. Members ....................................................................................................................................... 3106
1077. Members ....................................................................................................................................... 3106
1078. Members ....................................................................................................................................... 3107
1079. Members ....................................................................................................................................... 3107
1080. Members ....................................................................................................................................... 3111
1081. Members ....................................................................................................................................... 3112
1082. Members ....................................................................................................................................... 3112
1083. Members ....................................................................................................................................... 3113
1084. Members ....................................................................................................................................... 3113
1085. Members ....................................................................................................................................... 3113
1086. Members ....................................................................................................................................... 3114
1087. Members ....................................................................................................................................... 3114
1088. Members ....................................................................................................................................... 3114
1089. Members ....................................................................................................................................... 3115
1090. Members ....................................................................................................................................... 3116

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

1091. Members ....................................................................................................................................... 3116


1092. Members ....................................................................................................................................... 3116
1093. Members ....................................................................................................................................... 3117
1094. Members ....................................................................................................................................... 3117
1095. Members ....................................................................................................................................... 3117
1096. Members ....................................................................................................................................... 3118
1097. Members ....................................................................................................................................... 3118
1098. Members ....................................................................................................................................... 3118
1099. Members ....................................................................................................................................... 3119
1100. Members ....................................................................................................................................... 3119
1101. Members ....................................................................................................................................... 3119
1102. Members ....................................................................................................................................... 3120
1103. Members ....................................................................................................................................... 3120
1104. Members ....................................................................................................................................... 3120
1105. Members ....................................................................................................................................... 3121
1106. Members ....................................................................................................................................... 3121
1107. Members ....................................................................................................................................... 3121
1108. Members ....................................................................................................................................... 3122
1109. Members ....................................................................................................................................... 3122
1110. Members ....................................................................................................................................... 3122
1111. Members ....................................................................................................................................... 3123
1112. Members ....................................................................................................................................... 3123
1113. Members ....................................................................................................................................... 3123
1114. Members ....................................................................................................................................... 3124
1115. Members ....................................................................................................................................... 3124
1116. Members ....................................................................................................................................... 3124
1117. Members ....................................................................................................................................... 3125
1118. Members ....................................................................................................................................... 3125
1119. Members ....................................................................................................................................... 3125
1120. Members ....................................................................................................................................... 3125
1121. Members ....................................................................................................................................... 3126
1122. Members ....................................................................................................................................... 3126
1123. Members ....................................................................................................................................... 3127
1124. Members ....................................................................................................................................... 3127
1125. Members ....................................................................................................................................... 3128
1126. Members ....................................................................................................................................... 3128
1127. Members ....................................................................................................................................... 3128
1128. Members ....................................................................................................................................... 3129
1129. Members ....................................................................................................................................... 3129
1130. Members ....................................................................................................................................... 3129
1131. Members ....................................................................................................................................... 3130
1132. Members ....................................................................................................................................... 3130
1133. Members ....................................................................................................................................... 3130
1134. Members ....................................................................................................................................... 3131
1135. Members ....................................................................................................................................... 3131
1136. Members ....................................................................................................................................... 3131
1137. Members ....................................................................................................................................... 3132
1138. Members ....................................................................................................................................... 3132
1139. Members ....................................................................................................................................... 3132
1140. Members ....................................................................................................................................... 3133
1141. Members ....................................................................................................................................... 3133
1142. Members ....................................................................................................................................... 3133

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

1143. Members ....................................................................................................................................... 3133


1144. Members ....................................................................................................................................... 3134
1145. Members ....................................................................................................................................... 3134
1146. Members ....................................................................................................................................... 3134
1147. Members ....................................................................................................................................... 3135
1148. Members ....................................................................................................................................... 3136
1149. Members ....................................................................................................................................... 3136
1150. Members ....................................................................................................................................... 3138
1151. Members ....................................................................................................................................... 3138
1152. Members ....................................................................................................................................... 3138
1153. Members ....................................................................................................................................... 3139
1154. Members ....................................................................................................................................... 3139
1155. Members ....................................................................................................................................... 3139
1156. Members ....................................................................................................................................... 3140
1157. Members ....................................................................................................................................... 3140
1158. Members ....................................................................................................................................... 3140
1159. Members ....................................................................................................................................... 3141
1160. Members ....................................................................................................................................... 3141
1161. Members ....................................................................................................................................... 3141
1162. Members ....................................................................................................................................... 3142
1163. Members ....................................................................................................................................... 3142
1164. Members ....................................................................................................................................... 3142
1165. Members ....................................................................................................................................... 3143
1166. Members ....................................................................................................................................... 3143
1167. Members ....................................................................................................................................... 3144
1168. Members ....................................................................................................................................... 3144
1169. Members ....................................................................................................................................... 3144
1170. Members ....................................................................................................................................... 3144
1171. Members ....................................................................................................................................... 3145
1172. Members ....................................................................................................................................... 3145
1173. Members ....................................................................................................................................... 3146
1174. Members ....................................................................................................................................... 3146
1175. Members ....................................................................................................................................... 3146
1176. Members ....................................................................................................................................... 3147
1177. Members ....................................................................................................................................... 3147
1178. Members ....................................................................................................................................... 3147
1179. Members ....................................................................................................................................... 3148
1180. Members ....................................................................................................................................... 3148
1181. Members ....................................................................................................................................... 3148
1182. Members ....................................................................................................................................... 3149
1183. Members ....................................................................................................................................... 3156
1184. Members ....................................................................................................................................... 3157
1185. Members ....................................................................................................................................... 3157
1186. Members ....................................................................................................................................... 3157
1187. Members ....................................................................................................................................... 3158
1188. Members ....................................................................................................................................... 3158
1189. Members ....................................................................................................................................... 3158
1190. Members ....................................................................................................................................... 3159
1191. Members ....................................................................................................................................... 3159
1192. Members ....................................................................................................................................... 3159
1193. Members ....................................................................................................................................... 3160
1194. Members ....................................................................................................................................... 3160

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

1195. Members ....................................................................................................................................... 3160


1196. Members ....................................................................................................................................... 3163
1197. Members ....................................................................................................................................... 3163
1198. Members ....................................................................................................................................... 3164
1199. Members ....................................................................................................................................... 3164
1200. Members ....................................................................................................................................... 3165
1201. Members ....................................................................................................................................... 3165
1202. Members ....................................................................................................................................... 3165
1203. Members ....................................................................................................................................... 3166
1204. Members ....................................................................................................................................... 3166
1205. Members ....................................................................................................................................... 3166
1206. Members ....................................................................................................................................... 3167
1207. Members ....................................................................................................................................... 3167
1208. Members ....................................................................................................................................... 3167
1209. Members ....................................................................................................................................... 3168
1210. Members ....................................................................................................................................... 3168
1211. Members ....................................................................................................................................... 3168
1212. Members ....................................................................................................................................... 3169
1213. Members ....................................................................................................................................... 3169
1214. Members ....................................................................................................................................... 3169
1215. Members ....................................................................................................................................... 3169
1216. Members ....................................................................................................................................... 3170
1217. Members ....................................................................................................................................... 3170
1218. Members ....................................................................................................................................... 3170
1219. Members ....................................................................................................................................... 3171
1220. Members ....................................................................................................................................... 3172
1221. Members ....................................................................................................................................... 3172
1222. Members ....................................................................................................................................... 3172
1223. Members ....................................................................................................................................... 3173
1224. Members ....................................................................................................................................... 3173
1225. Members ....................................................................................................................................... 3174
1226. Members ....................................................................................................................................... 3174
1227. Members ....................................................................................................................................... 3174
1228. Members ....................................................................................................................................... 3174
1229. Members ....................................................................................................................................... 3175
1230. Members ....................................................................................................................................... 3175
1231. Members ....................................................................................................................................... 3175
1232. Members ....................................................................................................................................... 3176
1233. Members ....................................................................................................................................... 3176
1234. Members ....................................................................................................................................... 3176
1235. Members ....................................................................................................................................... 3177
1236. Members ....................................................................................................................................... 3177
1237. Members ....................................................................................................................................... 3177
1238. Members ....................................................................................................................................... 3178
1239. Members ....................................................................................................................................... 3178
1240. Members ....................................................................................................................................... 3178
1241. Members ....................................................................................................................................... 3178
1242. Members ....................................................................................................................................... 3179
1243. Members ....................................................................................................................................... 3179
1244. Members ....................................................................................................................................... 3179
1245. Members ....................................................................................................................................... 3180
1246. Members ....................................................................................................................................... 3180

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

1247. Members ....................................................................................................................................... 3180


1248. Members ....................................................................................................................................... 3181
1249. Members ....................................................................................................................................... 3181
1250. Members ....................................................................................................................................... 3181
1251. Members ....................................................................................................................................... 3182
1252. Members ....................................................................................................................................... 3182
1253. Members ....................................................................................................................................... 3182
1254. Members ....................................................................................................................................... 3183
1255. Members ....................................................................................................................................... 3183
1256. Members ....................................................................................................................................... 3183
1257. Members ....................................................................................................................................... 3183
1258. Members ....................................................................................................................................... 3184
1259. Members ....................................................................................................................................... 3184
1260. Members ....................................................................................................................................... 3184
1261. Members ....................................................................................................................................... 3185
1262. Members ....................................................................................................................................... 3185
1263. Members ....................................................................................................................................... 3185
1264. Members ....................................................................................................................................... 3186
1265. Members ....................................................................................................................................... 3186
1266. Members ....................................................................................................................................... 3186
1267. Members ....................................................................................................................................... 3187
1268. Members ....................................................................................................................................... 3187
1269. Members ....................................................................................................................................... 3187
1270. Members ....................................................................................................................................... 3187
1271. Members ....................................................................................................................................... 3188
1272. Members ....................................................................................................................................... 3188
1273. Members ....................................................................................................................................... 3188
1274. Members ....................................................................................................................................... 3189
1275. Members ....................................................................................................................................... 3189
1276. Members ....................................................................................................................................... 3189
1277. Members ....................................................................................................................................... 3190
1278. Members ....................................................................................................................................... 3190
1279. Members ....................................................................................................................................... 3190
1280. Members ....................................................................................................................................... 3191
1281. Members ....................................................................................................................................... 3191
1282. Members ....................................................................................................................................... 3191
1283. Members ....................................................................................................................................... 3194
1284. Members ....................................................................................................................................... 3195
1285. Members ....................................................................................................................................... 3195
1286. Members ....................................................................................................................................... 3195
1287. Members ....................................................................................................................................... 3196
1288. Members ....................................................................................................................................... 3196
1289. Members ....................................................................................................................................... 3196
1290. Members ....................................................................................................................................... 3197
1291. Members ....................................................................................................................................... 3197
1292. Members ....................................................................................................................................... 3198
1293. Members ....................................................................................................................................... 3198
1294. Members ....................................................................................................................................... 3198
1295. Members ....................................................................................................................................... 3199
1296. Members ....................................................................................................................................... 3199
1297. Members ....................................................................................................................................... 3200
1298. Members ....................................................................................................................................... 3200

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

1299. Members ....................................................................................................................................... 3200


1300. Members ....................................................................................................................................... 3201
1301. Members ....................................................................................................................................... 3203
1302. Members ....................................................................................................................................... 3203
1303. Members ....................................................................................................................................... 3211
1304. Members ....................................................................................................................................... 3223
1305. Members ....................................................................................................................................... 3223
1306. Members ....................................................................................................................................... 3224
1307. Members ....................................................................................................................................... 3226
1308. Members ....................................................................................................................................... 3227
1309. Members ....................................................................................................................................... 3227
1310. Members ....................................................................................................................................... 3229
1311. Members ....................................................................................................................................... 3230
1312. Members ....................................................................................................................................... 3230
1313. Members ....................................................................................................................................... 3231
1314. Members ....................................................................................................................................... 3231
1315. Members ....................................................................................................................................... 3232
1316. Members ....................................................................................................................................... 3233
1317. Members ....................................................................................................................................... 3237
1318. Members ....................................................................................................................................... 3237
1319. Members ....................................................................................................................................... 3239
1320. Members ....................................................................................................................................... 3244
1321. Members ....................................................................................................................................... 3245
1322. Members ....................................................................................................................................... 3246
1323. Members ....................................................................................................................................... 3248
1324. Members ....................................................................................................................................... 3250
1325. Members ....................................................................................................................................... 3252
1326. Members ....................................................................................................................................... 3253
1327. Members ....................................................................................................................................... 3253
1328. Members ....................................................................................................................................... 3253
1329. Members ....................................................................................................................................... 3254
1330. Members ....................................................................................................................................... 3254
1331. Members ....................................................................................................................................... 3255
1332. Members ....................................................................................................................................... 3256
1333. Members ....................................................................................................................................... 3256
1334. Members ....................................................................................................................................... 3257
1335. Members ....................................................................................................................................... 3259
1336. Members ....................................................................................................................................... 3260
1337. Members ....................................................................................................................................... 3261
1338. Members ....................................................................................................................................... 3262
1339. Members ....................................................................................................................................... 3265
1340. Members ....................................................................................................................................... 3267
1341. Members ....................................................................................................................................... 3268
1342. Members ....................................................................................................................................... 3270
1343. Members ....................................................................................................................................... 3271
1344. Members ....................................................................................................................................... 3272
1345. Members ....................................................................................................................................... 3274
1346. Members ....................................................................................................................................... 3276
1347. Members ....................................................................................................................................... 3281
1348. Members ....................................................................................................................................... 3284
1349. Members ....................................................................................................................................... 3284
1350. Members ....................................................................................................................................... 3285

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

1351. Members ....................................................................................................................................... 3286


1352. Members ....................................................................................................................................... 3289
1353. Members ....................................................................................................................................... 3290
1354. Members ....................................................................................................................................... 3291
1355. Members ....................................................................................................................................... 3293
1356. Members ....................................................................................................................................... 3295
1357. Members ....................................................................................................................................... 3295
1358. Members ....................................................................................................................................... 3297
1359. Members ....................................................................................................................................... 3299
1360. Members ....................................................................................................................................... 3299
1361. Members ....................................................................................................................................... 3301
1362. Members ....................................................................................................................................... 3301
1363. Members ....................................................................................................................................... 3302
1364. Members ....................................................................................................................................... 3305
1365. Members ....................................................................................................................................... 3308
1366. Members ....................................................................................................................................... 3312
1367. Members ....................................................................................................................................... 3316
1368. Members ....................................................................................................................................... 3316
1369. Members ....................................................................................................................................... 3317
1370. Members ....................................................................................................................................... 3317
1371. Members ....................................................................................................................................... 3318
1372. Members ....................................................................................................................................... 3318
1373. Members ....................................................................................................................................... 3318
1374. Members ....................................................................................................................................... 3319
1375. Members ....................................................................................................................................... 3319
1376. Members ....................................................................................................................................... 3320
1377. Members ....................................................................................................................................... 3322
1378. Members ....................................................................................................................................... 3323
1379. Members ....................................................................................................................................... 3326
1380. Members ....................................................................................................................................... 3328
1381. Members ....................................................................................................................................... 3331
1382. Members ....................................................................................................................................... 3331
1383. Members ....................................................................................................................................... 3332
1384. Members ....................................................................................................................................... 3333
1385. Members ....................................................................................................................................... 3334
1386. Members ....................................................................................................................................... 3337
1387. Members ....................................................................................................................................... 3341
1388. Members ....................................................................................................................................... 3342
1389. Members ....................................................................................................................................... 3343
1390. Members ....................................................................................................................................... 3353
1391. Members ....................................................................................................................................... 3356
1392. Members ....................................................................................................................................... 3358
1393. Members ....................................................................................................................................... 3359
1394. Members ....................................................................................................................................... 3360
1395. Members ....................................................................................................................................... 3360
1396. Members ....................................................................................................................................... 3361
1397. Members ....................................................................................................................................... 3365
1398. Members ....................................................................................................................................... 3368
1399. Members ....................................................................................................................................... 3369
1400. Members ....................................................................................................................................... 3369
1401. Members ....................................................................................................................................... 3371
1402. Members ....................................................................................................................................... 3372

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

1403. Members ....................................................................................................................................... 3372


1404. Members ....................................................................................................................................... 3374
1405. Members ....................................................................................................................................... 3374
1406. Members ....................................................................................................................................... 3376
1407. Members ....................................................................................................................................... 3378
1408. Members ....................................................................................................................................... 3378
1409. Members ....................................................................................................................................... 3379
1410. Members ....................................................................................................................................... 3380
1411. Members ....................................................................................................................................... 3381
1412. Members ....................................................................................................................................... 3384
1413. Members ....................................................................................................................................... 3384
1414. Members ....................................................................................................................................... 3385
1415. Members ....................................................................................................................................... 3387
1416. Members ....................................................................................................................................... 3388
1417. Members ....................................................................................................................................... 3388
1418. Members ....................................................................................................................................... 3388
1419. Members ....................................................................................................................................... 3389
1420. Members ....................................................................................................................................... 3390
1421. Members ....................................................................................................................................... 3392
1422. Members ....................................................................................................................................... 3393
1423. Members ....................................................................................................................................... 3394
1424. Members ....................................................................................................................................... 3397
1425. Members ....................................................................................................................................... 3398
1426. Members ....................................................................................................................................... 3399
1427. Members ....................................................................................................................................... 3400
1428. Members ....................................................................................................................................... 3402
1429. Members ....................................................................................................................................... 3403
1430. Members ....................................................................................................................................... 3405
1431. Members ....................................................................................................................................... 3406
1432. Members ....................................................................................................................................... 3406
1433. Members ....................................................................................................................................... 3407
1434. Members ....................................................................................................................................... 3408
1435. Members ....................................................................................................................................... 3409
1436. Members ....................................................................................................................................... 3411
1437. Members ....................................................................................................................................... 3411
1438. Members ....................................................................................................................................... 3413
1439. Members ....................................................................................................................................... 3414
1440. Members ....................................................................................................................................... 3414
1441. Members ....................................................................................................................................... 3414
1442. Members ....................................................................................................................................... 3417
1443. Members ....................................................................................................................................... 3418
1444. Members ....................................................................................................................................... 3419
1445. Members ....................................................................................................................................... 3420
1446. Members ....................................................................................................................................... 3421
1447. Members ....................................................................................................................................... 3422
1448. Members ....................................................................................................................................... 3423
1449. Members ....................................................................................................................................... 3424
1450. Members ....................................................................................................................................... 3426
1451. Members ....................................................................................................................................... 3426
1452. Members ....................................................................................................................................... 3428
1453. Members ....................................................................................................................................... 3429
1454. Members ....................................................................................................................................... 3429

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

1455. Members ....................................................................................................................................... 3430


1456. Members ....................................................................................................................................... 3430
1457. Members ....................................................................................................................................... 3431
1458. Members ....................................................................................................................................... 3433
1459. Members ....................................................................................................................................... 3433
1460. Members ....................................................................................................................................... 3434
1461. Members ....................................................................................................................................... 3443
1462. Members ....................................................................................................................................... 3445
1463. Members ....................................................................................................................................... 3447
1464. Members ....................................................................................................................................... 3449
1465. Members ....................................................................................................................................... 3449
1466. Members ....................................................................................................................................... 3452
1467. Members ....................................................................................................................................... 3455
1468. Members ....................................................................................................................................... 3455
1469. Members ....................................................................................................................................... 3457
1470. Members ....................................................................................................................................... 3460
1471. Members ....................................................................................................................................... 3461
1472. Members ....................................................................................................................................... 3464
1473. Members ....................................................................................................................................... 3465
1474. Members ....................................................................................................................................... 3472
1475. Members ....................................................................................................................................... 3474
1476. Members ....................................................................................................................................... 3478
1477. Members ....................................................................................................................................... 3491
1478. Members ....................................................................................................................................... 3491
1479. Members ....................................................................................................................................... 3495
1480. Members ....................................................................................................................................... 3496
1481. Members ....................................................................................................................................... 3500
1482. Members ....................................................................................................................................... 3501
1483. Members ....................................................................................................................................... 3507
1484. Members ....................................................................................................................................... 3507
1485. Members ....................................................................................................................................... 3508
1486. Members ....................................................................................................................................... 3508
1487. Members ....................................................................................................................................... 3509
1488. Members ....................................................................................................................................... 3510
1489. Members ....................................................................................................................................... 3510
1490. Members ....................................................................................................................................... 3515
1491. Members ....................................................................................................................................... 3521
1492. Members ....................................................................................................................................... 3521
1493. Members ....................................................................................................................................... 3528
1494. Members ....................................................................................................................................... 3530
1495. Members ....................................................................................................................................... 3531
1496. Members ....................................................................................................................................... 3533
1497. Members ....................................................................................................................................... 3533
1498. Members ....................................................................................................................................... 3534
1499. Members ....................................................................................................................................... 3535
1500. Members ....................................................................................................................................... 3543
1501. Members ....................................................................................................................................... 3548
1502. Members ....................................................................................................................................... 3553

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ccxxix
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
ccxxx 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
Ansys.ACT.Core Namespace

Declaration Syntax
public class ProcessUtilities : IProcessUtilities

Table 3: Members

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


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

Start(string, params string[])


Starts an application, file, or other target.

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

Parameters
target(string)
The fully-qualified path to the application, file, or other target

args(string[])
Command line arguments

Start(string, bool, params string[])


Starts an application, file, or other target.

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

Parameters
target(string)
The fully-qualified path to the application, file, or other target

useShell(bool)
Indicates whether or not to execute the target using the OS shell

args(string[])
Command line arguments

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

Table 4: Members

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


entry.

IDataModelProvider
No details are provided for this entry.

Declaration Syntax
public interface IDataModelProvider

Table 5: Members

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


entry.

DataModel
No details are provided for this entry.

Declaration Syntax
public object DataModel { get; }

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

Table 6: Members

AttributeCollection (p. 7) A collection of attributes.


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

AttributeCollection
A collection of attributes.

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

Table 7: Members

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


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

Item(string)
Get or set an attribute value.

Declaration Syntax
public object Item { set;get; }

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

Keys
The list of the available keys in the collection.

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

Clone()
Create a clone of the currection collection.

Declaration Syntax
public AttributeCollection Clone()

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

Declaration Syntax
public virtual bool Contains(string name)

Parameters
name(string)
The attribute name.

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

Declaration Syntax
public virtual string GetStringValue(string name)

Parameters
name(string)
The name of the attribute.

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

Declaration Syntax
public virtual object GetValue(string name)

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

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)

Parameters
name(string)
The name of the attribute.

value(object)
The value of the attrbiute.

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

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Selection Namespace
Declaration Syntax
namespace Ansys.Mechanical.Selection

Table 9: Members

SelectionHelper (p. 11) No details are provided for this


entry.

SelectionHelper
No details are provided for this entry.

Declaration Syntax
public class SelectionHelper

Table 10: Members

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

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

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

Parameters
selection(ISelectionInfo)
No details are provided for this entry.

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

reversed(bool)
No details are provided for this entry.

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

Table 11: Members

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


AnimationExportSettings (p. 13) No details are provided for this entry.
Graphics3DExportSettings (p. 14) No details are provided for this entry.
GraphicsImageExportSettings (p. 15) No details are provided for this entry.
Point (p. 17) No details are provided for this entry.
ResultAnimationOptions (p. 18) No details are provided for this entry.
SectionPlane (p. 20) Represents a SectionPlane object. This object holds properties
of the Plane.
SectionPlanes (p. 22) Represents the collection of section planes used by graphics

AnalysisSettingsGraph
No details are provided for this entry.

Declaration Syntax
public class AnalysisSettingsGraph

Table 12: Members

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


entry.

BoundaryConditionVisibility
No details are provided for this entry.

Declaration Syntax
public BoundaryConditionVisibilityDictionary BoundaryConditionVisibility { get; }

AnimationExportSettings
No details are provided for this entry.

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

Declaration Syntax
public class AnimationExportSettings

Table 13: Members

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

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

Declaration Syntax
public AnimationExportSettings(int width, int height)

Parameters
width(int)
No details are provided for this entry.

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

Height
Specifies the video height.

Declaration Syntax
public int Height { set;get; }

Width
Specifies the video width.

Declaration Syntax
public int Width { set;get; }

Graphics3DExportSettings
No details are provided for this entry.

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

Declaration Syntax
public class Graphics3DExportSettings

Table 14: Members

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


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

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

Declaration Syntax
public Graphics3DExportSettings()

Background
Specifies the background color.

Declaration Syntax
public GraphicsBackgroundType Background { set;get; }

GraphicsImageExportSettings
No details are provided for this entry.

Declaration Syntax
public class GraphicsImageExportSettings

Table 15: Members

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


instance.
Property Background (p. 16) Specifies the background color. Defaults to
GraphicsAppearanceSetting.
Property Capture (p. 16) Specifies what to include in the capture. Defaults
to ImageAndLegend.
Property CurrentGraphicsDisplay (p. 16) Specifies whether to use the current graphics
display settings. Defaults to true.
Property FontMagnification (p. 16) Specifies the font magnification factor. Defaults
to 1.0.
Property Height (p. 17) Specifies the image height. Defaults to 0. If width
AND height are zero, this uses the current
dimensions. If only one of the two are nonzero,

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

the current dimension’s ratio is used along with


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

GraphicsImageExportSettings()
Creates a new GraphicsImageExportSettings instance.

Declaration Syntax
public GraphicsImageExportSettings()

Background
Specifies the background color. Defaults to GraphicsAppearanceSetting.

Declaration Syntax
public GraphicsBackgroundType Background { set;get; }

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

Declaration Syntax
public GraphicsCaptureType Capture { set;get; }

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

Declaration Syntax
public bool CurrentGraphicsDisplay { set;get; }

FontMagnification
Specifies the font magnification factor. Defaults to 1.0.

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

Declaration Syntax
public double FontMagnification { set;get; }

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

Declaration Syntax
public int Height { set;get; }

Resolution
Specifies the resolution type. Defaults to NormalResolution.

Declaration Syntax
public GraphicsResolutionType Resolution { set;get; }

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

Declaration Syntax
public int Width { set;get; }

Point
No details are provided for this entry.

Declaration Syntax
public class Point : IEquatable<Point>

Table 16: Members

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


Property Location (p. 18) The location of the
Point.
Property Unit (p. 18) The length unit of the
Point.

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

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

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

Parameters
location(IList<object>)
The location of the point.

lengthUnit(string)
The unit of measurement.

Location
The location of the Point.

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

Unit
The length unit of the Point.

Declaration Syntax
public string Unit { set;get; }

ResultAnimationOptions
No details are provided for this entry.

Declaration Syntax
public class ResultAnimationOptions

Table 17: Members

Property Duration (p. 19) Gets or Sets the Duration for Result Animation.
Property FitDeformationScalingToAnimation (p. 19) Gets or Sets if the Animation Displacement Fits
for full range of Time Steps in the Screen.
Property NumberOfFrames (p. 19) Gets or Sets the Number Of Frames for
Distributed Result Animation.
Property RangeType (p. 19) Gets or Sets the Range Type for Result
Animation.

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

Property TimeDecayCycles (p. 19) Gets or Sets the Number of Cycles for Time
Decay.
Property UpdateContourRangeAtEachFrame (p. 19) Gets or Sets if the Legend Contours will Update
at Each Frame.

Duration
Gets or Sets the Duration for Result Animation.

Declaration Syntax
public Quantity Duration { set;get; }

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

Declaration Syntax
public bool FitDeformationScalingToAnimation { set;get; }

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

Declaration Syntax
public int NumberOfFrames { set;get; }

RangeType
Gets or Sets the Range Type for Result Animation.

Declaration Syntax
public ResultAnimationRangeType RangeType { set;get; }

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

Declaration Syntax
public int TimeDecayCycles { set;get; }

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

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

Declaration Syntax
public bool UpdateContourRangeAtEachFrame { set;get; }

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

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

Table 18: Members

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


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

SectionPlane()
Creates a SectionPlane Object

Declaration Syntax
public SectionPlane()

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


Creates a SectionPlane Object with the specified property values

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

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

Parameters
center(Point)
Center of the Section Plane

direction(Vector3D)
Direction of the Section Plane

name(string)
Name for the Section Plane

type(SectionPlaneType)
No details are provided for this entry.

active(bool)
No details are provided for this entry.

Active
Gets or Sets the Active State of the Section Plane

Declaration Syntax
public bool Active { set;get; }

Center
Gets or Sets the Center point of the Section Plane

Declaration Syntax
public Point Center { set;get; }

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

Declaration Syntax
public Vector3D Direction { set;get; }

Name
Gets or Sets the Name of the Section Plane

Declaration Syntax
public string Name { set;get; }

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

Type
Gets or Sets the SectionPlane Type of the Section Plane

Declaration Syntax
public SectionPlaneType Type { set;get; }

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

Declaration Syntax
public virtual bool Equals(SectionPlane sectionPlane)

Parameters
sectionPlane(SectionPlane)
A SectionPlane Object

SectionPlanes
Represents the collection of section planes used by graphics

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

Table 19: Members

Property Capping (p. 22) Gets or Sets the Capping style of the Section Plane
Property Count (p. 23) The number of section planes in the collection.
Property ShowWholeElement (p. 23) Gets or Sets the Element Visibility of the Section Plane
Method Add(SectionPlane) (p. 23) Adds the given SectionPlane object to the collection to
modify the view. Currently only 6 SectionPlane objects in
the collection can be activated at once.
Method Clear() (p. 23) Clears the collection of all SectionPlane objects.
Method Remove(SectionPlane) (p. 23) Removes the requested SectionPlane from the collection.
Method RemoveAt(int) (p. 24) Removes the SectionPlane at the given index.

Capping
Gets or Sets the Capping style of the Section Plane

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

Declaration Syntax
public SectionPlaneCappingType Capping { set;get; }

Count
The number of section planes in the collection.

Declaration Syntax
public int Count { get; }

ShowWholeElement
Gets or Sets the Element Visibility of the Section Plane

Declaration Syntax
public bool ShowWholeElement { set;get; }

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

Declaration Syntax
public virtual void Add(SectionPlane sectionPlane)

Parameters
sectionPlane(SectionPlane)
The sectionPlane object to add

Clear()
Clears the collection of all SectionPlane objects.

Declaration Syntax
public virtual void Clear()

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

Declaration Syntax
public virtual bool Remove(SectionPlane sectionPlane)

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

Parameters
sectionPlane(SectionPlane)
No details are provided for this entry.

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

Declaration Syntax
public void RemoveAt(int index)

Parameters
index(int)
The index of the SectionPlane to remove

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

Table 20: Members

Message (p. 25) A message.


Messages (p. 27) Defines the collection of Mechanical's
messages.
ObjectTag (p. 28) An instance of an ObjectTag.
ObjectTags (p. 30) Defines the collection of Mechanical’s tags.
Progress (p. 33) Defines a Progress.

Message
A message.

Declaration Syntax
public class Message : IEquatable<Message>

Table 21: Members

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


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

DisplayString
The display string of the message.

Declaration Syntax
public string DisplayString { get; }

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

Location
The location of the message.

Declaration Syntax
public ISelectionInfo Location { get; }

RelatedObjects
The list of objects related to the message.

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

Severity
The severity of the message.

Declaration Syntax
public MessageSeverityType Severity { set;get; }

Source
The source object of the message.

Declaration Syntax
public DataModelObject Source { set;get; }

StringID
The string ID of the message.

Declaration Syntax
public string StringID { set;get; }

TimeStamp
The timestamp of the message.

Declaration Syntax
public DateTime TimeStamp { get; }

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

Messages
Defines the collection of Mechanical's messages.

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

Table 22: Members

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


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

Count
Get the number of messages.

Declaration Syntax
public int Count { get; }

Add(Message)
Add a new message.

Declaration Syntax
public virtual void Add(Message item)

Parameters
item(Message)
The message to be added.

Clear()
Clear the list of the messages.

Declaration Syntax
public virtual void Clear()

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

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

Declaration Syntax
public virtual bool Contains(Message item)

Parameters
item(Message)
The message to be searched for.

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

Declaration Syntax
public virtual bool Remove(Message item)

Parameters
item(Message)
The message to be removed.

ShowErrors()
Shows errors with current project.

Declaration Syntax
public virtual void ShowErrors()

ObjectTag
An instance of an ObjectTag.

Declaration Syntax
public class ObjectTag : IObjectTag

Table 23: Members

Constructor ObjectTag(string) (p. 29) Creates a new tag with the given name
Property Name (p. 29) The name of the tag. If the tag exists in
ObjectTags, attempting to set the name to a
value of another tag in that collection will lead
to an exception.

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

Property Objects (p. 29) The list of objects which use this tag.
Method AddObject(DataModelObject) (p. 29) Add an object to this tag.
Method ClearObjects() (p. 30) Clear all objects from this tag.
Method RemoveObject(DataModelObject) (p. 30) Remove an object from this tag.

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

Declaration Syntax
public ObjectTag(string name)

Parameters
name(string)
No details are provided for this entry.

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

Declaration Syntax
public string Name { set;get; }

Objects
The list of objects which use this tag.

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

AddObject(DataModelObject)
Add an object to this tag.

Declaration Syntax
public virtual void AddObject(DataModelObject obj)

Parameters
obj(DataModelObject)
No details are provided for this entry.

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

ClearObjects()
Clear all objects from this tag.

Declaration Syntax
public virtual void ClearObjects()

RemoveObject(DataModelObject)
Remove an object from this tag.

Declaration Syntax
public virtual void RemoveObject(DataModelObject obj)

Parameters
obj(DataModelObject)
No details are provided for this entry.

ObjectTags
Defines the collection of Mechanical’s tags.

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

Table 24: Members

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


Property Item (p. 31) Retrieves the tag in the collection at the given index.
Property Item (p. 31) Retrieves the tag in the collection with the given name
Property TagNames (p. 31) The names of the tags in the collection.
Method Add(ObjectTag) (p. 31) Adds a new tag to the collection. Throws an error if the tag
already exists in the collection.
Method Clear() (p. 31) Clears the collection, removing all objects from the tags in
the collection.
Method Contains(ObjectTag) (p. 32) Returns whether or not the collection contains the given tag.
Method GetTag(string) (p. 32) Returns the tag in the collection with the given name.
Method IndexOf(ObjectTag) (p. 32) Returns the index of the given tag. If the given tag does not
exist in the collection, returns -1.
Method Remove(ObjectTag) (p. 32) Removes a tag if it exists in the collection.
Method RemoveAt(int) (p. 33) Removes the tag at the given index from the collection.

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

Count
The number of tags in the collection.

Declaration Syntax
public int Count { get; }

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

Declaration Syntax
public ObjectTag Item { get; }

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

Declaration Syntax
public ObjectTag Item { get; }

TagNames
The names of the tags in the collection.

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

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

Declaration Syntax
public virtual void Add(ObjectTag tag)

Parameters
tag(ObjectTag)
The ObjectTag to add

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

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

Declaration Syntax
public virtual void Clear()

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

Declaration Syntax
public virtual bool Contains(ObjectTag tag)

Parameters
tag(ObjectTag)
The ObjectTag to check

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

Declaration Syntax
public ObjectTag GetTag(string tagName)

Parameters
tagName(string)
The name of the tag to find and return

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

Declaration Syntax
public int IndexOf(ObjectTag tag)

Parameters
tag(ObjectTag)
The item to get the index of.

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

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

Declaration Syntax
public virtual bool Remove(ObjectTag tag)

Parameters
tag(ObjectTag)
The ObjectTag to remove

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

Declaration Syntax
public void RemoveAt(int index)

Parameters
index(int)
The index of the tag to remove

Progress
Defines a Progress.

Declaration Syntax
public class Progress

Table 25: Members

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

SetProgress(uint, string, uint, string)


Set the current progress state

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

Parameters
uiProgress(uint)
Main progress bar (values 0 to 100)

uiMessage(string)
Main progress message

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

uiSubProgress(uint)
Sub progress bar (values 0 to 100)

uiSubMessage(string)
Sub progress message

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Graphics

Table 26: Members

IModelViewManager (p. 35) No details are provided for this


entry.

IModelViewManager
No details are provided for this entry.

Declaration Syntax
public interface IModelViewManager

Table 27: Members

Property NumberOfViews (p. 36) The number of views currently defined.


Method ApplyModelView(int) (p. 36) Apply the view specified by index.
Method ApplyModelView(string) (p. 36) Apply the view specified by name.
Method CaptureModelView(int, string) (p. 36) Save the view specified by index as a PNG image
to the project userfiles.
Method CaptureModelView(string, string) (p. 37) Save the view specified as an image to the
project userfiles.
Method CreateView() (p. 37) Create a view from current graphics with default
naming.
Method CreateView(string) (p. 37) Create a view from current graphics with the
specified name.
Method DeleteView(int) (p. 37) Delete the specified view by index.
Method DeleteView(string) (p. 38) Apply the view specified by name.
Method ExportModelViews(string) (p. 38) Export model views to the specified file.
Method ImportModelViews(string) (p. 38) Import model views from the specified file.
Method RenameView(int, string) (p. 38) Rename the model view specified by viewIndex
to newLabel.
Method RenameView(string, string) (p. 39) Rename the model view specified to newLabel.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
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.

mode(string)
A string representing the graphics format to use. One of : "PNG", "JPG", "TIF", "BMP", "EPS".

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

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", "TIF", "BMP", "EPS".

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.

Declaration Syntax
public void DeleteView(int viewIndex)

Parameters
viewIndex(int)
The index of the listed view to be deleted.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
Ansys.ACT.Interfaces.Graphics Namespace

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)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
IModelViewManager

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Mechanical

Table 28: Members

IMechanicalDataModel (p. 41) Defines the data model of the Mechanical


application.
IMechanicalExtAPI (p. 44) Exposes the main entry point of all ATC APIs.
IMechanicalGraphics (p. 44) Interface for MechanicalGraphics.
IMechanicalSelectionInfo (p. 45) Defines the mechanical selection information.
IMechanicalUserLoad (p. 46) Defines a Mechanical user load.
IMechanicalUserObject (p. 46) Defines a Mechanical user object.
IMechanicalUserResult (p. 46) Defines a Mechanical user result.
IMechanicalUserSolver (p. 46) Defines a Mechanical user solver.
MechanicalPanelEnum (p. 47) Specifies the panel type.

IMechanicalDataModel
Defines the data model of the Mechanical application.

Declaration Syntax
public interface IMechanicalDataModel

Table 29: Members

Property ObjectTags (p. 42) Gets the ObjectTags object for the
Data Model, which represents the
current list of tags visable in the User
Interface.
Property Project (p. 42) Gets the project object. Main object
of the tree of Mechanical.
Property Tree (p. 42) Gets the tree of Mechanical.
Method CurrentUnitFromQuantityName(string) (p. 42) Returns the current unit from a
quantity name.
Method GetObjectById(int) (p. 42) Returns the Mechanical object
related to the provided Id.

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

Method GetObjectsByName(string) (p. 43) Gets a list of all objects with the
specified name.
Method GetObjectsByType(DataModelObjectCategory) (p. 43) Gets a list of all objects with the
specified type.
Method GetObjectsByType(Type) (p. 43) Gets a list of all objects with the
specified type.

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.

GetObjectById(int)
Returns the Mechanical object related to the provided Id.

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

Declaration Syntax
public DataModelObject GetObjectById(int id)

Parameters
id(int)
The id of the object.

GetObjectsByName(string)
Gets a list of all objects with the specified name.

Declaration Syntax
public IList<DataModelObject> GetObjectsByName(string name)

Parameters
name(string)
The object's name.

GetObjectsByType(DataModelObjectCategory)
Gets a list of all objects with the specified type.

Declaration Syntax
public IList<DataModelObject> GetObjectsByType(DataModelObjectCategory dataModelObjectCategory)

Parameters
dataModelObjectCategory(DataModelObjectCategory)
The category of the object to retrieve.

GetObjectsByType(Type)
Gets a list of all objects with the specified type.

Declaration Syntax
public IList<DataModelObject> GetObjectsByType(Type type)

Parameters
type(Type)
The object's type.

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

IMechanicalExtAPI
Exposes the main entry point of all ATC APIs.

Declaration Syntax
public interface IMechanicalExtAPI

Table 30: Members

Method LockPrePostLicense() (p. 44) Locks the license used by the PRE/POST application.
Method UnlockPrePostLicense() (p. 44) 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.

Declaration Syntax
public interface IMechanicalGraphics

Table 31: Members

Property ModelViewManager (p. 45) An instance of the


ModelViewManager.
Property SectionPlanes (p. 45) An instance of the SectionPlanes.

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

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 32: Members

Property ElementFaceIndices (p. 45) Gets the list indices needed to define the face of an
element.
Property Entities (p. 45) 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; }

Entities
Gets the list of selected geometry entities.

Declaration Syntax
public IList<IGeoEntity> Entities { get; }

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

IMechanicalUserLoad
Defines a Mechanical user load.

Declaration Syntax
public interface IMechanicalUserLoad

IMechanicalUserObject
Defines a Mechanical user object.

Declaration Syntax
public interface IMechanicalUserObject

Table 33: Members

Property Analysis (p. 46) 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

IMechanicalUserSolver
Defines a Mechanical user solver.

Declaration Syntax
public interface IMechanicalUserSolver

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

MechanicalPanelEnum
Specifies the panel type.

Declaration Syntax
public enum MechanicalPanelEnum

Table 34: 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.DesignModeler

Table 35: Members

IDesignModelerDataModel (p. 50) Defines the DesignModeler data model.


IDesignModelerExtAPI (p. 51) Defines the main entry point of all APIs.
IDesignModelerGeoData (p. 52) Defines the DesignModeler geometry data model.
IDesignModelerGeoFeature (p. 52) Defines a DesignModeler custom feature.
IDesignModelerSelectionInfo (p. 53) Defines the DesignModeler selection information.
IExtrude (p. 54) Defines an "Extrude" operation.
IGeometryBuilder (p. 55) Defines the geometry builder.
IIntersect (p. 56) Defines an "Intersect" operation.
IOperations (p. 56) Defines a list of available geometry operations.
IOperationTools (p. 58) Defines a list of tools to manipulate the geometry.
IPrimitives (p. 63) Defines the list of creatable primitives.
IPSGeoBody (p. 63) Defines a body.
IPSGeoEdge (p. 64) Defines an edge.
IPSGeoEntity (p. 64) Defines a generic geometry entity.
IPSGeoFace (p. 64) Defines a face.
IPSGeoPart (p. 64) Defines a part.
IQueries (p. 64) Defines a list of available queries on the geometry.
IRevolve (p. 66) Defines a "Revolve" operation.
ISheetCone (p. 67) Defines a sheet cone primitive.
ISheetCylinder (p. 68) Defines a sheet cylinder primitive.
ISheetPolygon (p. 69) Defines a sheet polygon primitive.
ISheets (p. 70) Defines the list all creatable sheet geometry
primitives.
ISheetSphere (p. 71) Defines a sheet sphere primitive.
ISolidBox (p. 71) Defines a solid box primitive.
ISolidCone (p. 72) Defines a solid cone primitive.
ISolidCylinder (p. 73) Defines a solid cylinder primitive.
ISolids (p. 74) Defines the list of all creatable solid geometry
primitives.
ISolidSphere (p. 76) Defines a solid sphere primitive.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
Ansys.ACT.Interfaces.DesignModeler Namespace

ISubtract (p. 76) Defines a "Subtract" operation.


IUnion (p. 77) Defines an "Union" operation.
IWireArc (p. 77) Defines a wire arc primitive.
IWireBCurve (p. 79) Defines awire b-curve primitive.
IWireEllipse (p. 79) Defines a wire ellipse primitive.
IWirePolyline (p. 80) Defines a wire polyline primitive.
IWires (p. 81) Defines the list of all creatable wire geometry
primitives.

IDesignModelerDataModel
Defines the DesignModeler data model.

Declaration Syntax
public interface IDesignModelerDataModel

Table 36: Members

Property Components (p. 50) Gets all components (named selections).


Property GeoData (p. 50) Gets the geometry data model object.
Property GeometryBuilder (p. 51) Gets the geometry builder object.
Property Queries (p. 51) Gets the queries object.
Method ComponentById(int) (p. 51) Returns the component (named selection)
associated to the specified identifier.
Method CurrentUnitFromQuantityName(string) (p. 51) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
50 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.

Declaration Syntax
public interface IDesignModelerExtAPI

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
Ansys.ACT.Interfaces.DesignModeler Namespace

IDesignModelerGeoData
Defines the DesignModeler geometry data model.

Declaration Syntax
public interface IDesignModelerGeoData

Table 37: Members

Property Bodies (p. 52) Gets all


bodies.
Property Parts (p. 52) 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 38: Members

Property Bodies (p. 53) Gets or sets the list of bodies or


parts generated by the feature.
Property MaterialType (p. 53) Gets or sets the material type used
to generate the feature.
Method AddProblematicGeometry(IEnumerable<IPSGeoEntity>, Add a list of geometry entities has
string) (p. 53) problemetic geometries.

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

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.

Declaration Syntax
public interface IDesignModelerSelectionInfo

Table 39: Members

Property Entities (p. 53) Gets the list of selected geometry entities.
Property Locations (p. 54) Gets the location point for each selected
entities.

Entities
Gets the list of selected geometry entities.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
Ansys.ACT.Interfaces.DesignModeler Namespace

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 40: Members

Property Depth (p. 54) Gets or Sets the depth of the extrusion.
Property Direction (p. 54) Gets or Sets the direction of the extrusion.
Property Walled (p. 54) Gets or Sets the walled flag.
Method ApplyTo(IPSGeoEntity) (p. 55) Applies the operation to the profile given in
argument.

Depth
Gets or Sets the depth of the extrusion.

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.

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

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 41: Members

Property Operations (p. 55) Gets the list of creatable


operations.
Property Primitives (p. 55) Gets the list of creatable
primitives.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
Ansys.ACT.Interfaces.DesignModeler Namespace

IIntersect
Defines an "Intersect" operation.

Declaration Syntax
public interface IIntersect

Table 42: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 56) 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.

Declaration Syntax
public interface IOperations

Table 43: Members

Property Queries (p. 57) Gets the list of methods to


query information on the
geometry.
Property Tools (p. 57) Gets the list of additional
tools to manipulate the
geometry.
Method CreateExtrudeOperation(IEnumerable<double>, Creates an "Extrude"
double) (p. 57) operation.
Method CreateIntersectOperation(IEnumerable<IPSGeoBody>) (p. 57) Creates an "Intersect"
operation.
Method CreateRevolveOperation(IEnumerable<double>, Creates a "Revolve"
IEnumerable<double>) (p. 58) operation.

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

Method CreateSubtractOperation(IEnumerable<IPSGeoBody>) (p. 58) Creates a "Subtract"


operation.
Method CreateUnionOperation() (p. 58) 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)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
Ansys.ACT.Interfaces.DesignModeler Namespace

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)

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 44: Members

Method CopyBody(IPSGeoBody) (p. 59) Copies a body.


Method CreatePart(IEnumerable<IPSGeoBody>) (p. 59) Creates a new part (group of bodies).

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

Method DeleteBody(IPSGeoBody) (p. 60) Deletes a body.


Method EdgesToWireBody(IEnumerable<IPSGeoEdge>) (p. 60) Transforms a set of edges into a wire
body.
Method FacesToSheetBody(IEnumerable<IPSGeoFace>) (p. 60) Transforms a set of faces to a sheet
body.
Method Imprint(IPSGeoBody, Imprints a list of bodies to a target
IEnumerable<IPSGeoBody>) (p. 60) body.
Method OffsetFace(IEnumerable<IPSGeoFace>, double) (p. 61) Does a normal offset of faces with a
given offset value.
Method SheetBodyToSolidBody(IPSGeoBody) (p. 61) Transforms a sheet body to a solid
body.
Method SimplifyTopology(IPSGeoEntity) (p. 61) Simplifies the topology of the given
entity.
Method ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, Does a thicken operation on a body
double, double) (p. 62) and remove some faces.
Method TransformBody(IPSGeoBody, Matrix4D) (p. 62) Transform a body.
Method WireToSheetBody(IPSGeoBody) (p. 62) Transforms a wire body to a sheet
body.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
Ansys.ACT.Interfaces.DesignModeler Namespace

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)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
IOperationTools

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)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
Ansys.ACT.Interfaces.DesignModeler Namespace

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)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
IPSGeoBody

IPrimitives
Defines the list of creatable primitives.

Declaration Syntax
public interface IPrimitives

Table 45: Members

Property Sheet (p. 63) Gets the list of all creatable sheet geometry
primitives.
Property Solid (p. 63) Gets the list of all creatable solid geometry
primitives.
Property Wire (p. 63) 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.

Declaration Syntax
public interface IPSGeoBody

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
Ansys.ACT.Interfaces.DesignModeler Namespace

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.

Declaration Syntax
public interface IQueries

Table 46: Members

Method Clash(IEnumerable<IPSGeoEntity>, Detects clash between 2 sets of


IEnumerable<IPSGeoEntity>) (p. 65) geometry entities.
Method Coincidence(IPSGeoEntity, IPSGeoEntity) (p. 65) Checks if 2 geometry entities are
coincident.

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

Method Containment(IPSGeoEntity, IPSGeoEntity) (p. 65) Checks if one geometry entity contains
one other.
Method Distance(IEnumerable<IPSGeoEntity>, Computes the distance between 2 sets
IEnumerable<IPSGeoEntity>) (p. 66) 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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
Ansys.ACT.Interfaces.DesignModeler Namespace

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 47: Members

Property Angle (p. 66) Gets or sets the angle of the revolution.
Property Axis (p. 66) Gets or sets the axis of the revolution (x, y, z).
Property Origin (p. 67) Gets or sets the origin of the revolution (x, y, z).
Property Walled (p. 67) Gets or sets the walled flag.
Method ApplyTo(IPSGeoEntity) (p. 67) 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).

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

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)

Parameters
profile(IPSGeoEntity)
The profile to revolve.

ISheetCone
Defines a sheet cone primitive.

Declaration Syntax
public interface ISheetCone

Table 48: Members

Property Center (p. 68) Gets or sets the center of the cone (x, y,
z).
Property Direction (p. 68) Gets or sets the direction of the cone (x,
y, z).
Property Radius1 (p. 68) Gets or sets the top radius of the cone.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
Ansys.ACT.Interfaces.DesignModeler Namespace

Property Radius2 (p. 68) 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; }

ISheetCylinder
Defines a sheet cylinder primitive.

Declaration Syntax
public interface ISheetCylinder

Table 49: Members

Property Center (p. 69) Gets or sets the center of the


cylinder.
Property Direction (p. 69) Gets or sets the axis of the
cylinder.

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

Property Radius (p. 69) 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; }

ISheetPolygon
Defines a sheet polygon primitive.

Declaration Syntax
public interface ISheetPolygon

Table 50: Members

Property Points (p. 69) 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
Ansys.ACT.Interfaces.DesignModeler Namespace

ISheets
Defines the list all creatable sheet geometry primitives.

Declaration Syntax
public interface ISheets

Table 51: Members

Method CreateCylinder(IEnumerable<double>, Creates a sheet cylinder primitive


IEnumerable<double>, double) (p. 70) generator.
Method CreatePolygon(IEnumerable<double>) (p. 70) 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)

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.

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

ISheetSphere
Defines a sheet sphere primitive.

Declaration Syntax
public interface ISheetSphere

Table 52: Members

Property Center (p. 71) Gets or sets the center of the


sphere.
Property Radius (p. 71) 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; }

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 53: Members

Property Point1 (p. 71) Gets or sets the first point of the box (x, y,
z).
Property Point2 (p. 72) 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).

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
Ansys.ACT.Interfaces.DesignModeler Namespace

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.

Declaration Syntax
public interface ISolidCone

Table 54: Members

Property Center (p. 72) Gets or sets the center of the cone (x, y,
z).
Property Direction (p. 72) Gets or sets the direction of the cone (x,
y, z).
Property Radius1 (p. 73) Gets or sets the top radius of the cone.
Property Radius2 (p. 73) 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; }

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

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; }

ISolidCylinder
Defines a solid cylinder primitive.

Declaration Syntax
public interface ISolidCylinder

Table 55: Members

Property Center (p. 73) Gets or sets the center of the cylinder (x, y,
z).
Property Direction (p. 73) Gets or sets the direction of the cylinder (x,
y, z).
Property Radius (p. 74) 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
Ansys.ACT.Interfaces.DesignModeler Namespace

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.

Declaration Syntax
public interface ISolids

Table 56: Members

Method CreateBox(IEnumerable<double>, Creates a box primitive generator.


IEnumerable<double>) (p. 74)
Method CreateCone(IEnumerable<double>, Creates a cone primitive
IEnumerable<double>, double, double) (p. 74) generator.
Method CreateCylinder(IEnumerable<double>, Creates a cylinder primitive
IEnumerable<double>, double) (p. 75) generator.
Method CreateSphere(IEnumerable<double>, double) (p. 75) 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.

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

Declaration Syntax
public ISolidCone CreateCone(IEnumerable<double> center, IEnumerable<double> direction, double
radius1, double radius2)

Parameters
center(IEnumerable<double>)
Center of the cone.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
Ansys.ACT.Interfaces.DesignModeler Namespace

radius(double)
The radius of the sphere.

ISolidSphere
Defines a solid sphere primitive.

Declaration Syntax
public interface ISolidSphere

Table 57: Members

Property Center (p. 76) Gets or sets the center of the sphere (x,
y, z).
Property Radius (p. 76) 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 58: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 76) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
76 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 59: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 77) 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 60: Members

Property Center (p. 78) Gets or sets the center of the arc (x, y, z).
Property EndAngle (p. 78) Gets or sets the end angle of the arc.
Property Normal (p. 78) Gets or sets the normal of the arc (x, y, z).

Release 2020 R1 - © 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 Radius (p. 78) Gets or sets the radius of the arc.
Property StartAngle (p. 78) Gets or sets the start angle of the arc.
Property XDir (p. 78) 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; }

XDir
Gets or sets the principal dircetion of the arc (x, y, z).

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

Declaration Syntax
public IEnumerable<double> XDir { set;get; }

IWireBCurve
Defines awire b-curve primitive.

Declaration Syntax
public interface IWireBCurve

Table 61: Members

Property Closed (p. 79) Gets of sets the closed flag.


Property Points (p. 79) 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.

Declaration Syntax
public interface IWireEllipse

Table 62: Members

Property Center (p. 80) Gets or sets the center of the ellipse (x, y, z).
Property LargeRadius (p. 80) Gets or sets the large radius of the ellipse.
Property Normal (p. 80) Gets or sets the normal direction of the ellipse (x,
y, z).

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
Ansys.ACT.Interfaces.DesignModeler Namespace

Property SmallRadius (p. 80) Gets or sets the small radius of the ellipse.
Property XDir (p. 80) 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; }

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.

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

Declaration Syntax
public interface IWirePolyline

Table 63: 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; }

IWires
Defines the list of all creatable wire geometry primitives.

Declaration Syntax
public interface IWires

Table 64: Members

Method CreateArc(double, IEnumerable<double>, Creates an arc primitive


IEnumerable<double>, IEnumerable<double>) (p. 81) generator.
Method CreateBCurve(IEnumerable<double>) (p. 82) Creates a b-curve primitive
generator.
Method CreateEllipse(double, double, IEnumerable<double>, Creates an ellipse primitive
IEnumerable<double>, IEnumerable<double>) (p. 82) generator.
Method CreatePolyline(IEnumerable<double>) (p. 83) Creates a polyline primitive
generator.

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)

Release 2020 R1 - © 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
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.

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.

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

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.DesignModeler.Primitives.Sheet Namespace
Declaration Syntax
namespace Ansys.ACT.DesignModeler.Primitives.Sheet

Table 65: Members

Cylinder (p. 85) Cylinder


Class

Cylinder
Cylinder Class

Declaration Syntax
public class Cylinder : Primitive, ISheetCylinder

Table 66: Members

Constructor Cylinder(GeometryBuilder, Create a new Cylinder.


IEnumerable<double>,
IEnumerable<double>, double) (p. 85)
Property Center (p. 86) Gets or sets the center of the cylinder.
Property Direction (p. 86) Gets or sets the axis of the cylinder.
Property Radius (p. 86) Gets or sets the radius of the cylinder.
Method Generate() (p. 86) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
86 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical

Table 67: Members

Transaction (p. 87) Speeds up bulk user


interactions.

Transaction
Speeds up bulk user interactions.

Declaration Syntax
public class Transaction : IDisposable

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
88 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Fields Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Fields

Table 68: Members

Field (p. 89) Represents a discrete or continuous field that can be used in a
component of a boundary condition from Mechanical, for instance.
Range (p. 90) Represents a domain for real values.
Variable (p. 91) 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. 94) 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 69: Members

Property Inputs (p. 89) Gets the input variables of this


component.
Property Name (p. 90) Gets the name of this component.
Property Output (p. 90) Gets the output variable of this
component.

Inputs
Gets the input variables of this component.

Declaration Syntax
public IList<Variable> Inputs { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
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 70: Members

Field Maximum (p. 90) No details are provided for this


entry.
Field Minimum (p. 90) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
90 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 71: Members

Property DefinitionType (p. 91) Gets a value that indicates how this variable is defined.
Property DiscreteValueCount (p. 92) Gets the number of discrete values of this variable.
Property DiscreteValues (p. 92) Gets or sets the discrete values of this variable or if this
variable represents a free degree of freedom.
null

Property Field (p. 92) Gets the owner field.


Property Formula (p. 92) 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. 92) Gets the index of this variable in its container field.
Property IsInput (p. 92) Gets a value indicating whether this variable is an input for
its container field. Otherwise, it is an output variable.
Property IsOutput (p. 93) Gets a value indicating whether this variable is an output for
its container field. Otherwise, it is an input variable.
Property MinMaxDiscreteValues (p. 93) Returns a Tuple containing the min and max values from the
list of discrete values.
Property Name (p. 93) Gets the variable's name.
Property QuantityName (p. 93) Gets the name of the quantity represented by this variable.
Property Range (p. 93) Gets the domain of validity for variable's value.
Property Unit (p. 93) Gets the symbol of the unit used to express this variable's
values.
Method GetDiscreteValue(int) (p. 94) 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. 94) of the variable.

DefinitionType
Gets a value that indicates how this variable is defined.

Declaration Syntax
public VariableDefinitionType DefinitionType { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
Ansys.ACT.Mechanical.Fields Namespace

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; }

IsInput
Gets a value indicating whether this variable is an input for its container field. Otherwise, it is an
output variable.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
92 of ANSYS, Inc. and its subsidiaries and affiliates.
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.

Declaration Syntax
public Range Range { get; }

Unit
Gets the symbol of the unit used to express this variable's values.

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

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.

Declaration Syntax
public enum VariableDefinitionType

Table 72: 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
94 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Fields.Adapters Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Fields.Adapters

Table 73: Members

FieldAdapter (p. 95) Base class for objects that handle the interface between the generic
boundary condition wrapper and the various types of concrete object
implemented in Mechanical.
FieldAdapterManager (p. 98) 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 74: Members

Constructor FieldAdapter(IDSBCInformation) (p. 95) No details are provided for this entry.
Property FieldProvider (p. 96) Gets the wrapped object from Mechanical.
Method ChangeFieldDefinitionType(AnsBCLVType, Changes the definition type for a field of the
kEDDataType) (p. 96) wrapped object from Mechanical.
NestedType IDefinition (p. 96) Interface implemented by objects that specify
a type of adapter for a given field provider
object from Mechanical.
NestedType Keywords (p. 97) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
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 75: Members

Method Adapt(IDSBCInformation) (p. 96) Creates an adapter for a given load object from
Mechanical.

Adapt(IDSBCInformation)
Creates an adapter for a given load object from Mechanical.

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

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 76: Members

Field Constant (p. 97) No details are provided for this


entry.
Field ConstantRamped (p. 97) No details are provided for this
entry.
Field Free (p. 98) No details are provided for this
entry.
Field Function (p. 98) No details are provided for this
entry.
Field Table (p. 98) No details are provided for this
entry.
Method Get(kEDDataType) (p. 98) 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.

Declaration Syntax
public static readonly string ConstantRamped

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
Ansys.ACT.Mechanical.Fields.Adapters Namespace

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.

Declaration Syntax
public static class FieldAdapterManager

Table 77: Members

Property AdapterDefinitions (p. 99) Gets the collection of adapters in this manager.
Method RegisterNewAdapter(IDefinition) (p. 99) Register the instance object that defines a type of
field adapter.

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

Method UnregisterAdapter(int) (p. 99) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
100 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Application.SolveProcessSettings

Table 78: Members

ILinuxSettings (p. 101) No details are provided for this entry.


IQueueSettings (p. 102) No details are provided for this entry.
ISolveConfiguration (p. 103) No details are provided for this entry.
ISolveProcessSettings (p. 104) No details are provided for this entry.
ISolverMemorySettings (p. 107) No details are provided for this entry.
LinuxSettings (p. 108) The class representing the linux settings portion of the solve process
settings.
QueueSettings (p. 109) The class representing queue settings.
RSMQueue (p. 110) The class representing an RSM Queue.
SolveConfiguration (p. 111) The class representing a solve configuration.
SolveProcessSettings (p. 112) The class representing solve process settings.
SolverMemorySettings (p. 115) 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 79: Members

Property Active (p. 101) Gets or sets whether or not manual linux settings are enable for
the configuration.
Property UserName (p. 102) Gets or sets the user name field for the manual linux settings.
Property WorkingFolder (p. 102) Gets or sets the working folder field for the manual linxus settings.

Active
Gets or sets whether or not manual linux settings are enable for the configuration.

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

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 80: Members

Property JobName (p. 102) Gets or sets the Job Name field for the queue settings.
Property License (p. 102) Gets or sets the License field for the queue settings.
Property Name (p. 103) Gets or sets the name of the current queue for the
configuration.

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.

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

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; }

ISolveConfiguration
No details are provided for this entry.

Declaration Syntax
public interface ISolveConfiguration

Table 81: Members

Property Default (p. 103) Gets whether or not this SolveConfiguration is the default
configuration.
Property Name (p. 103) Gets or sets the name of the SolveConfiguraiton Object
Property Settings (p. 103) Gets the QueueSettings object for the configuration.
Property SolveProcessSettings (p. 104) Gets the SolveProcessSettings for the current object.
Method SetAsDefault() (p. 104) 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.

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

Declaration Syntax
public IQueueSettings Settings { get; }

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 82: Members

Property AdditionalCommandLineArguments (p. 105) Gets or sets the "Additional Command Line
Arguments" field.
Property CustomExecutablePath (p. 105) Gets or sets the "Custom Executable Name
(with path)" field.
Property DistributeSolution (p. 105) Gets or sets the boolean "Distribute Solution
(if possible)" field.
Property GPUAccelerationDevice (p. 105) Gets or sets the "GPU Acceleration Device" field.
Property LicenseQueuing (p. 105) Gets or sets the "License Queuing: Wait for
Available License" field.
Property ManualLinuxSettings (p. 106) Gets the LinuxSettings object for the
configuration.
Property ManualSolverMemorySettings (p. 106) Gets the SolverMemorySettings object for the
configuration.
Property MaxNumberOfCores (p. 106) Gets or sets the "Maximum number of utilized
cores" field.
Property NumberOfGPUDevices (p. 106) Gets or sets the "Number of utilized GPU
devices" field.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
104 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolveProcessSettings

Property SolveInSynchronousMode (p. 106) Gets or sets the "Solve in synchronous mode"
field.
Property UserString (p. 106) Gets or sets the User String field.
Property UseSharedLicense (p. 107) 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; }

LicenseQueuing
Gets or sets the "License Queuing: Wait for Available License" field.

Declaration Syntax
public bool LicenseQueuing { set;get; }

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

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; }

SolveInSynchronousMode
Gets or sets the "Solve in synchronous mode" field.

Declaration Syntax
public bool SolveInSynchronousMode { set;get; }

UserString
Gets or sets the User String field.

Declaration Syntax
public string UserString { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
106 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolverMemorySettings

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 83: Members

Property Active (p. 107) Gets or sets whether or not manual memory settings are active in the
current configuration.
Property Database (p. 107) Gets or sets the database memory amount (MB).
Property Workspace (p. 107) Gets or sets the workspace memory amount (megabytes).

Active
Gets or sets whether or not manual memory settings are active in the current configuration.

Declaration Syntax
public bool Active { set;get; }

Database
Gets or sets the database memory amount (MB).

Declaration Syntax
public int Database { set;get; }

Workspace
Gets or sets the workspace memory amount (megabytes).

Declaration Syntax
public int Workspace { set;get; }

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

LinuxSettings
The class representing the linux settings portion of the solve process settings.

Declaration Syntax
public class LinuxSettings : ILinuxSettings

Table 84: Members

Constructor LinuxSettings() (p. 108) Creates a LinuxSettings object


Property Active (p. 108) Whether the linux settings are
active.
Property UserName (p. 108) The user name.
Property WorkingFolder (p. 108) The working folder.

LinuxSettings()
Creates a LinuxSettings object

Declaration Syntax
public LinuxSettings()

Active
Whether the linux settings are active.

Declaration Syntax
public bool Active { set;get; }

UserName
The user name.

Declaration Syntax
public string UserName { set;get; }

WorkingFolder
The working folder.

Declaration Syntax
public string WorkingFolder { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
QueueSettings

QueueSettings
The class representing queue settings.

Declaration Syntax
public class QueueSettings : IQueueSettings

Table 85: Members

Constructor QueueSettings() (p. 109) Creates a QueueSettings object


Property JobName (p. 109) The job name of the queue settings.
Property License (p. 109) The license of the queue settings. The setter will throw an
exception if the given license is not valid.
Property Name (p. 109) The name of the queue settings.

QueueSettings()
Creates a QueueSettings object

Declaration Syntax
public QueueSettings()

JobName
The job name of the queue settings.

Declaration Syntax
public string JobName { set;get; }

License
The license of the queue settings. The setter will throw an exception if the given license is not valid.

Declaration Syntax
public string License { set;get; }

Name
The name of the queue settings.

Declaration Syntax
public string Name { set;get; }

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

RSMQueue
The class representing an RSM Queue.

Declaration Syntax
public class RSMQueue

Table 86: Members

Property HPCConfiguration (p. 110) The HPC configuration of the RSM


Queue.
Property HPCQueue (p. 110) The HPC Queue of the RSM Queue.
Property HPCType (p. 110) The HPC type of the RSM Queue
Property Name (p. 110) The name of the RSM Queue.

HPCConfiguration
The HPC configuration of the RSM Queue.

Declaration Syntax
public string HPCConfiguration { get; }

HPCQueue
The HPC Queue of the RSM Queue.

Declaration Syntax
public string HPCQueue { get; }

HPCType
The HPC type of the RSM Queue

Declaration Syntax
public string HPCType { get; }

Name
The name of the RSM Queue.

Declaration Syntax
public string Name { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
110 of ANSYS, Inc. and its subsidiaries and affiliates.
SolveConfiguration

SolveConfiguration
The class representing a solve configuration.

Declaration Syntax
public class SolveConfiguration : ISolveConfiguration, IEquatable<SolveConfiguration>

Table 87: Members

Constructor SolveConfiguration() (p. 111) Creates a SolveConfiguration object


Constructor SolveConfiguration(string) (p. 111) Creates a SolveConfiguration object with a given name
or gets the instance of an existing SolveConfiguration
with that name.
Property Default (p. 111) Whether this solve configuration is the default.
Property Name (p. 112) The name of the solve configuration.
Property Settings (p. 112) Returns the queue settings of this solve configuration.
Property SolveProcessSettings (p. 112) Returns the solve process settings of this solve
configuration.
Method SetAsDefault() (p. 112) Sets this solve configuration as the default.

SolveConfiguration()
Creates a SolveConfiguration object

Declaration Syntax
public SolveConfiguration()

SolveConfiguration(string)
Creates a SolveConfiguration object with a given name or gets the instance of an existing SolveCon-
figuration with that name.

Declaration Syntax
public SolveConfiguration(string name)

Parameters
name(string)
No details are provided for this entry.

Default
Whether this solve configuration is the default.

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

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; }

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 88: Members

Constructor SolveProcessSettings() (p. 113) Creates a SolveProcessSettings object


Property AdditionalCommandLineArguments (p. 113) Any additional command line arguments to
give to the solver.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
112 of ANSYS, Inc. and its subsidiaries and affiliates.
SolveProcessSettings

Property CustomExecutablePath (p. 113) The custom executable path for user
programmable features in the solver.
Property DistributeSolution (p. 113) Whether to run the solution in distributed
mode.
Property GPUAccelerationDevice (p. 114) The GPU Acceleration device the solver will
use.
Property LicenseQueuing (p. 114) Whether license queueing is active.
Property ManualLinuxSettings (p. 114) Returns the manual linux settings.
Property ManualSolverMemorySettings (p. 114) Returns the manual solver memory settings.
Property MaxNumberOfCores (p. 114) The maximum number of cores the solver
will use.
Property NumberOfGPUDevices (p. 114) The number of GPU devices.
Property SolveInSynchronousMode (p. 115) Whether the solve will be in synchronous
mode.
Property UseSharedLicense (p. 115) 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; }

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

GPUAccelerationDevice
The GPU Acceleration device the solver will use.

Declaration Syntax
public GPUAccelerationDevicesType GPUAccelerationDevice { 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.
SolverMemorySettings

SolveInSynchronousMode
Whether the solve will be in synchronous mode.

Declaration Syntax
public bool SolveInSynchronousMode { 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 89: Members

Constructor SolverMemorySettings() (p. 115) Creates a SolverMemorySettings object


Property Active (p. 115) Whether the solver memory settings are
active.
Property Database (p. 116) Database size.
Property Workspace (p. 116) Workspace size.

SolverMemorySettings()
Creates a SolverMemorySettings object

Declaration Syntax
public SolverMemorySettings()

Active
Whether the solver memory settings are active.

Declaration Syntax
public bool Active { set;get; }

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

Database
Database size.

Declaration Syntax
public int Database { set;get; }

Workspace
Workspace size.

Declaration Syntax
public int Workspace { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
116 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Common Namespace
Declaration Syntax
namespace Ansys.ACT.Common

Table 90: Members

CoordinateSystem (p. 117) CoordinateSystem


class

CoordinateSystem
CoordinateSystem class

Declaration Syntax
public class CoordinateSystem : ICoordinateSystem

Table 91: Members

Constructor CoordinateSystem(CoordinateSystemTypeEnum) (p. 117) Constructor.


Property CoordinateSystemType (p. 118) Gets or sets the coordinate
system type.
Property Id (p. 118) Gets or sets the ID of the
coordinate system.
Property Matrix (p. 118) Gets or sets the matrix
definition of the coordinate
system.
Property Name (p. 118) Gets or sets the name of the
coordinate system.
Property Origin (p. 118) Gets or sets the origin of the
coordinate system.
Property XAxis (p. 119) Gets or sets the X axis of the
coordinate system.
Property YAxis (p. 119) Gets or sets the Y axis of the
coordinate system.
Property ZAxis (p. 119) Gets or sets the Z axis of the
coordinate system.

CoordinateSystem(CoordinateSystemTypeEnum)
Constructor.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 117
Ansys.ACT.Common Namespace

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; }

Origin
Gets or sets the origin of the coordinate system.

Declaration Syntax
public IEnumerable<double> Origin { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
118 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 119
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
120 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Common.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Common.Graphics

Table 92: Members

DMCameraWrapper (p. 121) Wrapper for Camera in Design


Modeler.
DMGraphicsWrapper (p. 121) Wrapper for Graphics in Design
Modeler.
MechanicalCameraWrapper (p. 121) Wrapper for Camera in Mechanical.
MechanicalGraphicsWrapper (p. 124) Wrapper for Graphics in Mechanical.
ModelViewManager (p. 126) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 121
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public class MechanicalCameraWrapper : CameraWrapper

Table 93: Members

Property FocalPoint (p. 122) The focal point of the camera


(coordinates are in the global
coordinate system).
Property SceneHeight (p. 122) Specifies the scene height (in
length units) that will be
projected and fit to the viewport.
Property SceneWidth (p. 122) Specifies the scene width (in
length units) that will be
projected and fit to the viewport.
Property UpVector (p. 123) The vector pointing up from the
focal point.
Property ViewVector (p. 123) The vector pointing from the focal
point to the camera.
Method GetAsString(ApplicationType) (p. 123) Retrieves the view commands as
related to the application type as
a string.
Method Rotate(double, CameraAxisType) (p. 123) Rotates the camera about an axis.
Method SetFit(ISelectionInfo) (p. 124) Fits the view to the specified
selection. If null is supplied, fits
the view to the entire model.
Method SetSpecificViewOrientation(ViewOrientationType) (p. 124)Sets a specific view orientation.

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; }

SceneWidth
Specifies the scene width (in length units) that will be projected and fit to the viewport.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
122 of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalCameraWrapper

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).

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).

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 123
Ansys.ACT.Common.Graphics Namespace

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)

Parameters
type(ViewOrientationType)
A view type (ISO, Front, Back, Left, Right, Top, Bottom).

MechanicalGraphicsWrapper
Wrapper for Graphics in Mechanical.

Declaration Syntax
public class MechanicalGraphicsWrapper : GraphicsWrapper, IMechanicalGraphics

Table 94: Members

Property Camera (p. 125) Gets the camera.


Property KeyframeAnimationUtility (p. 125) A utility for creating animations based on
keyframes.
Property ModelViewManager (p. 125) An instance of the ModelViewManager.
Property ResultAnimationOptions (p. 125) Gets the Global Result Animation options.
Property SectionPlanes (p. 125) Returns the collection of section planes used
by graphics
Property Unit (p. 125) Gets the current graphics unit.
Method Export3D(string, Graphics3DExportFormat, Exports the current Graphics display in a 3d
Graphics3DExportSettings) (p. 126) format to a file.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
124 of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalGraphicsWrapper

Method ExportImage(string, Exports the current Graphics display in a 2d


GraphicsImageExportFormat, format to a file.
GraphicsImageExportSettings) (p. 126)

Camera
Gets the camera.

Declaration Syntax
public MechanicalCameraWrapper Camera { 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; }

Unit
Gets the current graphics unit.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 125
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public string Unit { 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 in a 2d format to a file.

Declaration Syntax
public void ExportImage(string filePath, GraphicsImageExportFormat formatImage, GraphicsImageEx-
portSettings settings)

Parameters
filePath(string)
The file path to create the 2d image.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
126 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelViewManager

Declaration Syntax
public class ModelViewManager : IModelViewManager

Table 95: Members

Property ActiveViewPort (p. 127) No details are provided for this entry.
Property NumberOfViews (p. 127) The number of views currently defined.
Method ApplyModelView(int) (p. 127) Apply the view specified by index.
Method ApplyModelView(string) (p. 128) Apply the view specified by name.
Method CreateView() (p. 128) Create a view from current graphics with default
naming.
Method CreateView(string) (p. 128) Create a view from current graphics with the specified
name.
Method DeleteView(int) (p. 128) Delete the specified view by index.
Method DeleteView(string) (p. 129) Delete the specified view by name.
Method ExportModelViews(string) (p. 129) Export model views to the specified file.
Method ImportModelViews(string) (p. 129) Import model views from the specified file.
Method RenameView(int, string) (p. 130) Rename the model view specified by viewIndex to
newLabel.
Method RenameView(string, string) (p. 130) Rename the model view specified to newLabel.
Method SetActiveViewPort(int) (p. 130) Active a viewport.
Method SetActiveViewPort(int, int) (p. 130) Set the active of viewport.
Method SetViewPorts(int, bool) (p. 131) Set the number of viewports displayed.

ActiveViewPort
No details are provided for this entry.

Declaration Syntax
public MechanicalViewPort ActiveViewPort { get; }

NumberOfViews
The number of views currently defined.

Declaration Syntax
public int NumberOfViews { get; }

ApplyModelView(int)
Apply the view specified by index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 127
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public virtual void ApplyModelView(int viewIndex)

Parameters
viewIndex(int)
The index of the listed view to be applied.

ApplyModelView(string)
Apply the view specified by name.

Declaration Syntax
public virtual void ApplyModelView(string viewLabel)

Parameters
viewLabel(string)
The name of the view to be applied.

CreateView()
Create a view from current graphics with default naming.

Declaration Syntax
public virtual void CreateView()

CreateView(string)
Create a view from current graphics with the specified name.

Declaration Syntax
public virtual void CreateView(string viewName)

Parameters
viewName(string)
The name to be assigned to the new view.

DeleteView(int)
Delete the specified view by index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
128 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelViewManager

Declaration Syntax
public virtual void DeleteView(int viewIndex)

Parameters
viewIndex(int)
The index of the listed view to be deleted.

DeleteView(string)
Delete the specified view by name.

Declaration Syntax
public virtual void DeleteView(string viewLabel)

Parameters
viewLabel(string)
The name of the view to be deleted.

ExportModelViews(string)
Export model views to the specified file.

Declaration Syntax
public virtual void ExportModelViews(string viewfilepath)

Parameters
viewfilepath(string)
The name of the view (xml) export file.

ImportModelViews(string)
Import model views from the specified file.

Declaration Syntax
public virtual void ImportModelViews(string viewfilepath)

Parameters
viewfilepath(string)
The name of the view (xml) file to be imported.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 129
Ansys.ACT.Common.Graphics Namespace

RenameView(int, string)
Rename the model view specified by viewIndex to newLabel.

Declaration Syntax
public virtual void RenameView(int viewIndex, string newLabel)

Parameters
viewIndex(int)
The index of the listed view to be renamed.

newLabel(string)
The new name to be applied.

RenameView(string, string)
Rename the model view specified to newLabel.

Declaration Syntax
public virtual void RenameView(string viewLabel, string newLabel)

Parameters
viewLabel(string)
The label of the listed view to be renamed.

newLabel(string)
The new name to be applied.

SetActiveViewPort(int)
Active a viewport.

Declaration Syntax
public void SetActiveViewPort(int windowsId)

Parameters
windowsId(int)
The window index of the viewport to be made active.

SetActiveViewPort(int, int)
Set the active of viewport.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
130 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelViewManager

Declaration Syntax
public void SetActiveViewPort(int winRowIndex, int winColIndex)

Parameters
winRowIndex(int)
The row index of the viewport to be made active (The index is zero referenced).

winColIndex(int)
The column index of the viewport to be made active (The index is zero referenced).

SetViewPorts(int, bool)
Set the number of viewports displayed.

Declaration Syntax
public void SetViewPorts(int numViewPorts, bool horizontal)

Parameters
numViewPorts(int)
The number of viewports to display.

horizontal(bool)
Alignment is horizontal if "true" and vertical if "false". Applies when numViewPorts is 2.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 131
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
132 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.DesignModeler

Table 96: Members

Extrusion (p. 133) Defines a Extrusion.


Feature (p. 134) Defines a Feature.
FeatureManager (p. 135) Defines a
FeatureManager.
NamedSelection (p. 136) Defines a
NamedSelection.

Extrusion
Defines a Extrusion.

Declaration Syntax
public class Extrusion : Feature

Table 97: Members

Property Depth (p. 133) Gets or sets the Depth.


Property Depth2 (p. 134) Gets or sets the Depth2.
Property Id (p. 135) Gets the id of the feature.

(Inherited from
Feature (p. 134).)
Property Name (p. 135) Gets the name of the
feature.

(Inherited from
Feature (p. 134).)
Property Thin1 (p. 134) Gets or sets the Thin1.
Property Thin2 (p. 134) Gets or sets the Thin2.
Property Walled (p. 134) Gets or sets the Walled.

Depth
Gets or sets the Depth.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 133
Ansys.ACT.Automation.DesignModeler Namespace

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.

Declaration Syntax
public class Feature

Table 98: Members

Property Id (p. 135) Gets the id of the


feature.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
134 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureManager

Property Name (p. 135) 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 99: Members

Property Count (p. 135) Gets the number of features.


Property Item (p. 135) Gets a feature by its index.
Method CreateNamedSelection() (p. 136) Creates a new NamedSelection
feature.
Method Generate() (p. 136) Generates non-generated features
if any.

Count
Gets the number of features.

Declaration Syntax
public int Count { get; }

Item(int)
Gets a feature by its index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 135
Ansys.ACT.Automation.DesignModeler Namespace

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 100: Members

Property ExportNamedSelection (p. 136) Gets or sets the


ExportNamedSelection.
Property Id (p. 135) Gets the id of the feature.

(Inherited from Feature (p. 134).)


Property IncludeInLegend (p. 137) Gets or sets the IncludeInLegend.
Property Name (p. 135) Gets the name of the feature.

(Inherited from Feature (p. 134).)


Property NumGeometry (p. 137) Gets the NumGeometry.
Property PropagateNamedSelection (p. 137) Gets or sets the
PropagateNamedSelection.

ExportNamedSelection
Gets or sets the ExportNamedSelection.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
136 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 137
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
138 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical

Table 101: Members

AcousticsFarFieldResultWorksheet (p. 143) No details are provided for this entry.


AMOverhangConstraint (p. 147) Defines a AMOverhangConstraint.
Analysis (p. 149) Defines a Analysis.
AnalysisPly (p. 178) Defines a AnalysisPly.
ArbitraryCrack (p. 183) Defines a ArbitraryCrack.
BatchConnectionsWorksheet (p. 187) No details are provided for this entry.
Body (p. 192) Defines a Body.
CenterOfGravityConstraint (p. 209) Defines a CenterOfGravityConstraint.
Chart (p. 211) Defines a Chart.
ChartXAxis (p. 216) No details are provided for this entry.
CommandSnippet (p. 216) Defines a CommandSnippet.
Comment (p. 224) Defines a Comment.
ComplianceConstraint (p. 226) Defines a ComplianceConstraint.
CompositeCriterion (p. 227) Defines a CompositeCriterion.
CompositeCriterionDefinition (p. 229) No details are provided for this entry.
CompositeCriterionTerm (p. 231) No details are provided for this entry.
CondensedGeometry (p. 232) Defines a CondensedGeometry.
CondensedPart (p. 237) Defines a CondensedPart.
CondensedPartExpansionState (p. 245) No details are provided for this entry.
CondensedPartInfoTool (p. 246) Defines a CondensedPartInfoTool.
ConstructionGeometry (p. 249) Defines a ConstructionGeometry.
ContactDebonding (p. 253) Defines a ContactDebonding.
ContactMatch (p. 256) Defines a ContactMatch.
ContactMatchGroup (p. 258) Defines a ContactMatchGroup.
ContactSolutionInformation (p. 260) Defines a ContactSolutionInformation.
CoordinateSystem (p. 263) Defines a CoordinateSystem.
CoordinateSystems (p. 273) Defines a CoordinateSystems.
Crack ***OBSOLETE*** Deprecated class. Use Defines a Crack.
ArbitraryCrack or SemiEllipticalCrack
instead. (p. 277)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 139
Ansys.ACT.Automation.Mechanical Namespace

Criterion (p. 282) Defines a Criterion.


CriterionConstraint (p. 286) Defines a CriterionConstraint.
CrossSection (p. 287) Defines a CrossSection.
CrossSections (p. 291) Defines a CrossSections.
CyclicManufacturingConstraint (p. 294) Defines a CyclicManufacturingConstraint.
CyclicRegion (p. 295) Defines a CyclicRegion.
DisplacementConstraint (p. 297) Defines a DisplacementConstraint.
DistributedMass (p. 299) Defines a DistributedMass.
ElementOrientation (p. 300) Defines a ElementOrientation.
EndRelease (p. 305) Defines a EndRelease.
ExclusionRegion (p. 311) Defines a ExclusionRegion.
ExpansionSettings (p. 312) Defines a ExpansionSettings.
ExternalEnhancedModel (p. 318) Defines a ExternalEnhancedModel.
ExternalModelDataColl (p. 322) Defines a ExternalModelDataColl.
ExtrusionManufacturingConstraint (p. 326) Defines a ExtrusionManufacturingConstraint.
FatigueTool (p. 327) Defines a FatigueTool.
Figure (p. 336) Defines a Figure.
Fracture (p. 338) Defines a Fracture.
GeneralAxisymmetric (p. 343) Defines a GeneralAxisymmetric.
GenericCrack (p. 347) Defines a GenericCrack.
GenericDelamination (p. 350) Defines a GenericDelamination.
GenericPointMass (p. 353) Defines a GenericPointMass.
Geometry (p. 357) Defines a Geometry.
GlobalVonMisesStressConstraint (p. 373) Defines a GlobalVonMisesStressConstraint.
Image (p. 374) Defines a Image.
ImportedBoltPretensions (p. 377) Defines a ImportedBoltPretensions.
ImportedConstraintEquations (p. 378) Defines a ImportedConstraintEquations.
ImportedContacts (p. 379) Defines a ImportedContacts.
ImportedCoordinateSystems (p. 381) Defines a ImportedCoordinateSystems.
ImportedElementOrientations (p. 382) Defines a ImportedElementOrientations.
ImportedFlexibleRemoteConnectors (p. 383) Defines a ImportedFlexibleRemoteConnectors.
ImportedLayeredSection (p. 384) Defines a ImportedLayeredSection.
ImportedNodalOrientations (p. 385) Defines a ImportedNodalOrientations.
ImportedObject (p. 386) Defines a row object in Imported Objects.
ImportedPlies (p. 388) Defines a ImportedPlies.
ImportedPointMasses (p. 389) Defines a ImportedPointMasses.
ImportedPremeshedBoltPretensions (p. 391) Defines a ImportedPremeshedBoltPretensions.
ImportedRigidRemoteConnectors (p. 392) Defines a ImportedRigidRemoteConnectors.
ImportedShellThicknesses (p. 393) Defines a ImportedShellThicknesses.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
140 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedSpringConnectors (p. 394) Defines a ImportedSpringConnectors.
ImportedStresses (p. 395) Defines a ImportedStresses.
InitialCondition (p. 396) Defines a InitialCondition.
InitialConditions (p. 408) Defines a InitialConditions.
InterfaceDelamination (p. 411) Defines a InterfaceDelamination.
JointBushingWorksheet (p. 416) The worksheet of stiffness and damping
coefficients for a bushing type joint.
LayeredSection (p. 424) Defines a LayeredSection.
LayeredSectionWorksheet (p. 429) No details are provided for this entry.
LocalVonMisesStressConstraint (p. 434) Defines a LocalVonMisesStressConstraint.
ManufacturingConstraint (p. 435) Defines a ManufacturingConstraint.

Defines a ManufacturingConstraint.
MassConstraint (p. 438) Defines a MassConstraint.
Material (p. 439) Defines a Material.
MaterialAssignment (p. 443) Defines a MaterialAssignment.
MaterialPlot (p. 448) Defines a MaterialPlot.
Materials (p. 451) Defines a Materials.
MemberSizeManufacturingConstraint (p. 455) Defines a MemberSizeManufacturingConstraint.
MeshConnection (p. 457) Defines a MeshConnection.
MeshConnectionBase (p. 460) Defines a MeshConnectionBase.

Defines a MeshConnectionBase.
MeshConnectionGroup (p. 466) Defines a MeshConnectionGroup.
MeshControlWorksheet (p. 469) No details are provided for this entry.
MeshEdit (p. 472) Defines a MeshEdit.
MeshNumbering (p. 478) Defines a MeshNumbering.
Model (p. 482) Defines a Model.
MomentOfInertiaConstraint (p. 498) Defines a MomentOfInertiaConstraint.
NamedSelection (p. 500) Defines a NamedSelection.
NamedSelectionCriteria (p. 507) A collection of named selection criteria.
NamedSelectionCriterion (p. 510) No details are provided for this entry.
NamedSelections (p. 512) Defines a NamedSelections.
NastranExportOptions (p. 517) Defines the NastranExportOptions.
NaturalFrequencyConstraint (p. 520) Defines a NaturalFrequencyConstraint.
NodeMerge (p. 521) Defines a NodeMerge.

Defines a NodeMerge.
NodeMergeGroup (p. 526) Defines a NodeMergeGroup.
NodeMove (p. 529) Defines a NodeMove.
NumberingControl (p. 533) Defines a NumberingControl.
Objective (p. 538) Defines a Objective.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 141
Ansys.ACT.Automation.Mechanical Namespace

ObjectiveWorksheet (p. 541) No details are provided for this entry.


OptimizationRegion (p. 550) Defines a OptimizationRegion.
OptimizationRegionBaseClass (p. 552) Defines a OptimizationRegionBaseClass.
Part (p. 554) Defines a Part.
PartTransform (p. 563) Defines a PartTransform.
PartTransformGroup (p. 569) Defines a PartTransformGroup.
Path (p. 573) Defines a Path.
PeriodicRegion (p. 579) Defines a PeriodicRegion.
PhysicsRegion (p. 580) Defines a PhysicsRegion.
PipeIdealization (p. 587) Defines a PipeIdealization.
PointMass (p. 589) Defines a PointMass.
PostContactTool (p. 594) Defines a PostContactTool.
PreContactTool (p. 596) Defines a PreContactTool.
PreMeshedCrack (p. 597) Defines a PreMeshedCrack.
PreMeshedCyclicRegion (p. 600) Defines a PreMeshedCyclicRegion.
PrimaryCriterion (p. 602) Defines a PrimaryCriterion.
Project (p. 605) Defines a Project.
PullOutDirectionManufacturingConstraint (p. 611) Defines a
PullOutDirectionManufacturingConstraint.
ReactionForceConstraint (p. 613) Defines a ReactionForceConstraint.
RemotePoint (p. 615) Defines a RemotePoint.
RemotePoints (p. 622) Defines a RemotePoints.
ResponseConstraint (p. 625) Defines a ResponseConstraint.
ResponsePSDTool (p. 627) Defines a ResponsePSDTool.
SelectionWorksheet (p. 631) No details are provided for this entry.
SemiEllipticalCrack (p. 643) Defines a SemiEllipticalCrack.
SMARTCrackGrowth (p. 649) Defines a SMARTCrackGrowth.
Solid (p. 655) Defines a Solid.
Solution (p. 659) Defines a Solution.
SolutionCombination (p. 721) Defines a SolutionCombination.
SolutionCombinationDefinition (p. 736) No details are provided for this entry.
SolutionInformation (p. 744) Defines a SolutionInformation.
STL (p. 765) Defines a STL.
Surface (p. 770) Defines a Surface.
SurfaceCoating (p. 774) Defines a SurfaceCoating.
Symmetry (p. 778) Defines a Symmetry.
SymmetryGeneral (p. 782) Defines a SymmetryGeneral.
SymmetryManufacturingConstraint (p. 787) Defines a SymmetryManufacturingConstraint.
SymmetryRegion (p. 788) Defines a SymmetryRegion.
TemperatureConstraint (p. 791) Defines a TemperatureConstraint.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
142 of ANSYS, Inc. and its subsidiaries and affiliates.
AcousticsFarFieldResultWorksheet

ThermalPointMass (p. 792) Defines a ThermalPointMass.


Thickness (p. 795) Defines a Thickness.
Tree (p. 800) No details are provided for this entry.
TreeGroupingFolder (p. 806) Defines a TreeGroupingFolder.
VirtualCell (p. 808) Defines a VirtualCell.
VirtualTopology (p. 812) Defines a VirtualTopology.
VolumeConstraint (p. 819) Defines a VolumeConstraint.
Worksheet (p. 821) No details are provided for this entry.

AcousticsFarFieldResultWorksheet
No details are provided for this entry.

Declaration Syntax
public class AcousticsFarFieldResultWorksheet : Worksheet

Table 102: Members

Property RowCount (p. 143) Return the number of entries.


Method AddRow() (p. 144) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 144) Deletes a row from the worksheet at index.
Method DuplicateRow(int, int) (p. 144) Insert a row from the worksheet at index.
Method GetCoordinateSystemSelection(int) (p. 144) Gets the worksheet CoordinateSystemSelection
property at index.
Method GetXCoordinate(int) (p. 145) Gets the worksheet Mic X property at index.
Method GetYCoordinate(int) (p. 145) Gets the worksheet Mic Y property at index.
Method GetZCoordinate(int) (p. 145) Gets the worksheet Mic Z property at index.
Method InsertRow(int) (p. 145) Insert a row from the worksheet at index.
Method SetCoordinateSystemSelection(int, Sets the worksheet CoordinateSystemSelection
uint) (p. 146) property at index.
Method SetXCoordinate(int, double) (p. 146) Sets the worksheet Mic X property at index.
Method SetYCoordinate(int, double) (p. 146) Sets the worksheet Mic Y property at index.
Method SetZCoordinate(int, double) (p. 147) Sets the worksheet Mic Z property at index.

RowCount
Return the number of entries.

Declaration Syntax
public int RowCount { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 143
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.

DuplicateRow(int, int)
Insert a row from the worksheet at index.

Declaration Syntax
public virtual int DuplicateRow(int fromIndex, int toIndex)

Parameters
fromIndex(int)
No details are provided for this entry.

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

GetCoordinateSystemSelection(int)
Gets the worksheet CoordinateSystemSelection property at index.

Declaration Syntax
public uint GetCoordinateSystemSelection(int index)

Parameters
index(int)
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
144 of ANSYS, Inc. and its subsidiaries and affiliates.
AcousticsFarFieldResultWorksheet

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)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 145
Ansys.ACT.Automation.Mechanical Namespace

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.

newVal(uint)
No details are provided for this entry.

SetXCoordinate(int, double)
Sets the worksheet Mic X property at index.

Declaration Syntax
public void SetXCoordinate(int index, double newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(double)
No details are provided for this entry.

SetYCoordinate(int, double)
Sets the worksheet Mic Y property at index.

Declaration Syntax
public void SetYCoordinate(int index, double newVal)

Parameters
index(int)
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
146 of ANSYS, Inc. and its subsidiaries and affiliates.
AMOverhangConstraint

newVal(double)
No details are provided for this entry.

SetZCoordinate(int, double)
Sets the worksheet Mic Z property at index.

Declaration Syntax
public void SetZCoordinate(int index, double newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(double)
No details are provided for this entry.

AMOverhangConstraint
Defines a AMOverhangConstraint.

Declaration Syntax
public class AMOverhangConstraint : DataModelObject

Table 103: Members

Property BuildDirection (p. 147) Gets or sets the BuildDirection.


Property CoordinateSystem (p. 148) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 148) Gets the current DataModelObject's
category.
Property InternalObject (p. 148) Gets the internal object. For advanced usage
only.
Property OverhangAngle (p. 148) Gets or sets the OverhangAngle.
Property ScopingMethod (p. 148) Gets the ScopingMethod.
Property Selection (p. 148) Gets or sets the Selection.
Property Suppressed (p. 149) Gets or sets the Suppressed.
Method Delete() (p. 149) Run the Delete action.

BuildDirection
Gets or sets the BuildDirection.

Declaration Syntax
public CoordinateSystemAxisType BuildDirection { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 147
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 the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

Selection
Gets or sets the Selection.

Declaration Syntax
public OptimizationRegion Selection { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
148 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Analysis
Defines a Analysis.

Declaration Syntax
public class Analysis : DataModelObject, IAnalysis, IDataModelObject, IApplicationObject, IDataObject-
Container, IInternalDataObjectContainer, IFolderDataModelObject

Table 104: Members

Property Acoustics (p. 153) Gets or sets the Acoustics.


Property AMProcessSimulation (p. 153) Gets or sets the AMProcessSimulation.
Property AnalysisSettings (p. 153) Gets the AnalysisSettings.
Property AnalysisType (p. 154) Gets the AnalysisType.
Property CellId (p. 154) Gets the CellId.
Property Children (p. 154) Gets the list of children.
Property Comments (p. 154) Gets the list of associated comments.
Property DataModelObjectCategory (p. 154) Gets the current DataModelObject's category.
Property EnvironmentTemperature (p. 154) Gets or sets the EnvironmentTemperature.
Property Figures (p. 155) Gets the list of associated figures.
Property GenerateInputOnly (p. 155) Gets the GenerateInputOnly.
Property Images (p. 155) Gets the list of associated images.
Property InitialConditions (p. 155) Get InitialConditions.
Property InternalObject (p. 155) Gets the internal object. For advanced usage only.
Property PhysicsType (p. 155) Gets the PhysicsType.
Property Solution (p. 156) Gets the Solution.
Property Structural (p. 156) Gets or sets the Structural.
Property SystemCaption (p. 156) Gets the SystemCaption.

Release 2020 R1 - © 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 AddAcceleration() (p. 156) Creates a new Acceleration


Method AddAcousticAbsorptionElement() (p. 156) Creates a new AcousticAbsorptionElement
Method AddAcousticAbsorptionSurface() (p. 156) Creates a new AcousticAbsorptionSurface
Method AddAcousticDiffuseSoundField() (p. 157) Creates a new AcousticDiffuseSoundField
Method AddAcousticFarFieldRadationSurface() (p. 157) Creates a new AcousticFarFieldRadationSurface
Method AddAcousticFreeSurface() (p. 157) Creates a new AcousticFreeSurface
Method AddAcousticImpedanceBoundary() (p. 157) Creates a new AcousticImpedanceBoundary
Method AddAcousticImpedanceSheet() (p. 157) Creates a new AcousticImpedanceSheet
Method AddAcousticIncidentWaveSource() (p. 157) Creates a new AcousticIncidentWaveSource
Method AddAcousticLowReducedFrequency() (p. 158) Creates a new AcousticLowReducedFrequency
Method AddAcousticMassSource() (p. 158) Creates a new AcousticMassSource
Method AddAcousticPort() (p. 158) Creates a new AcousticPort
Method AddAcousticPortInDuct() (p. 158) Creates a new AcousticPortInDuct
Method AddAcousticPressure() (p. 158) Creates a new AcousticPressure
Method AddAcousticRadiationBoundary() (p. 158) Creates a new AcousticRadiationBoundary
Method AddAcousticRigidWall() (p. 159) Creates a new AcousticRigidWall
Method AddAcousticStaticPressure() (p. 159) Creates a new AcousticStaticPressure
Method AddAcousticSurfaceVelocity() (p. 159) Creates a new AcousticSurfaceVelocity
Method AddAcousticSymmetryPlane() (p. 159) Creates a new AcousticSymmetryPlane
Method AddAcousticTemperature() (p. 159) Creates a new child ThermalCondition.
Method AddAcousticThermoViscousBLIBoundary() (p. 159) Creates a new AcousticThermoViscousBLIBoundary
Method AddAcousticTransferAdmittanceMatrix() (p. 160) Creates a new AcousticTransferAdmittanceMatrix
Method AddAMOverhangConstraint() (p. 160) Creates a new AMOverhangConstraint
Method AddBearingLoad() (p. 160) Creates a new BearingLoad
Method AddBodyControl() (p. 160) Creates a new BodyControl
Method AddBoltPretension() (p. 160) Creates a new BoltPretension
Method AddCenterOfGravityConstraint() (p. 160) Creates a new CenterOfGravityConstraint
Method AddCommandSnippet() (p. 161) Creates a new CommandSnippet
Method AddComment() (p. 161) Creates a new child Comment.
Method AddComplianceConstraint() (p. 161) Creates a new ComplianceConstraint
Method AddCompressionOnlySupport() (p. 161) Creates a new CompressionOnlySupport
Method AddConstraintEquation() (p. 161) Creates a new ConstraintEquation
Method AddContactStepControl() (p. 161) Creates a new ContactStepControl
Method AddConvection() (p. 162) Creates a new Convection
Method AddCoupling() (p. 162) Creates a new Coupling
Method AddCriterionConstraint() (p. 162) Creates a new CriterionConstraint
Method AddCurrent() (p. 162) Creates a new Current
Method AddCyclicManufacturingConstraint() (p. 162) Creates a new CyclicManufacturingConstraint
Method AddCylindricalSupport() (p. 162) Creates a new CylindricalSupport

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
150 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Method AddDetonationPoint() (p. 163) Creates a new DetonationPoint


Method AddDisplacement() (p. 163) Creates a new Displacement
Method AddDisplacementConstraint() (p. 163) Creates a new DisplacementConstraint
Method AddEarthGravity() (p. 163) Creates a new EarthGravity
Method AddElasticSupport() (p. 163) Creates a new ElasticSupport
Method AddElementBirthAndDeath() (p. 163) Creates a new ElementBirthAndDeath
Method AddEMTransducer() (p. 164) Creates a new EMTransducer
Method AddExtrusionManufacturingConstraint() (p. 164) Creates a new ExtrusionManufacturingConstraint
Method AddFigure() (p. 164) Creates a new child Figure.
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. 165) Creates a new Force
Method AddFrictionlessSupport() (p. 165) Creates a new FrictionlessSupport
Method AddGeneralizedPlaneStrain() (p. 165) 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 AddHydrostaticPressure() (p. 166) Creates a new HydrostaticPressure
Method AddImage(string) (p. 166) Creates a new child Image. If a 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 AddImportedLoadResultFile() (p. 166) Creates a new Import Load (Result File).
Method AddInitialVelocity() (p. 166) Creates a new child Initial Velocity.
Method AddInternalHeatGeneration() (p. 166) Creates a new InternalHeatGeneration
Method AddJointLoad() (p. 167) Creates a new JointLoad
Method AddLinePressure() (p. 167) Creates a new LinePressure
Method AddLocalVonMisesStressConstraint() (p. 167) Creates a new LocalVonMisesStressConstraint
Method AddMagneticFluxParallel() (p. 167) Creates a new MagneticFluxParallel
Method AddMassConstraint() (p. 167) Creates a new MassConstraint
Method AddMassFlowRate() (p. 167) 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. 168) Creates a new NaturalFrequencyConstraint
Method AddNodalDisplacement() (p. 168) Creates a new NodalDisplacement
Method AddNodalForce() (p. 168) Creates a new NodalForce
Method AddNodalOrientation() (p. 169) Creates a new NodalOrientation

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 151
Ansys.ACT.Automation.Mechanical Namespace

Method AddNodalPressure() (p. 169) Creates a new NodalPressure


Method AddNodalRotation() (p. 169) Creates a new NodalRotation
Method AddNonlinearAdaptiveRegion() (p. 169) Creates a new NonlinearAdaptiveRegion
Method AddObjective() (p. 169) Creates a new Objective
Method AddOptimizationRegion() (p. 169) Creates a new OptimizationRegion
Method AddPerfectlyInsulated() (p. 170) Creates a new PerfectlyInsulated
Method AddPhysicsRegion() (p. 170) Creates a new PhysicsRegion
Method AddPipePressure() (p. 170) Creates a new PipePressure
Method AddPipeTemperature() (p. 170) Creates a new PipeTemperature
Method AddPlasticHeating() (p. 170) Creates a new PlasticHeating
Method AddPressure() (p. 170) Creates a new child Pressure.
Method AddPSDAcceleration() (p. 171) Creates a new PSDAcceleration
Method AddPSDDisplacement() (p. 171) Creates a new PSDDisplacement
Method AddPSDGAcceleration() (p. 171) Creates a new PSDGAcceleration
Method AddPSDVelocity() (p. 171) Creates a new PSDVelocity
Method AddPullOutDirectionManufacturingConstraint() (p. 171) Creates a new
PullOutDirectionManufacturingConstraint
Method AddRadiation() (p. 171) Creates a new Radiation
Method AddReactionForceConstraint() (p. 172) Creates a new ReactionForceConstraint
Method AddRemoteDisplacement() (p. 172) Creates a new RemoteDisplacement
Method AddRemoteForce() (p. 172) Creates a new RemoteForce
Method AddRotatingForce() (p. 172) Creates a new RotatingForce
Method AddRotationalAcceleration() (p. 172) Creates a new RotationalAcceleration
Method AddRotationalVelocity() (p. 172) Creates a new RotationalVelocity
Method AddRSAcceleration() (p. 173) Creates a new RSAcceleration
Method AddRSDisplacement() (p. 173) Creates a new RSDisplacement
Method AddRSVelocity() (p. 173) Creates a new RSVelocity
Method AddSimplySupported() (p. 173) Creates a new SimplySupported
Method AddSourceConductor() (p. 173) Creates a new child SourceConductor.
Method AddSymmetryManufacturingConstraint() (p. 173) Creates a new SymmetryManufacturingConstraint
Method AddSystemCouplingRegion() (p. 174) Creates a new SystemCouplingRegion
Method AddTemperature() (p. 174) Creates a new Temperature
Method AddTemperatureConstraint() (p. 174) Creates a new TemperatureConstraint
Method AddThermalCondition() (p. 174) Creates a new child ThermalCondition.
Method AddVelocity() (p. 174) Creates a new Velocity
Method AddViscoelasticHeating() (p. 174) Creates a new ViscoelasticHeating
Method AddVoltage() (p. 175) Creates a new Voltage
Method AddVolumeConstraint() (p. 175) Creates a new VolumeConstraint
Method ClearGeneratedData() (p. 175) Run the ClearGeneratedData action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
152 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Method CreateAutomaticFarFieldRadiationSurfaces() (p. 175) Run the CreateAutomaticEquivalentSourceSurfaces


action.
Method CreateAutomaticFSI() (p. 175) Run the CreateAutomaticFSI action.
Method CreateAutomaticFSIandFarFieldRadiationSurfaces() (p. 175) Run the
CreateAutomaticFSIandEquivalentSourceSurfaces
action.
Method ExportNastranFile(NastranExportOptions) (p. 176) Export Nastran File.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 176)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 176)
Method ImportLoad(Analysis) (p. 177) Import Load action.
Method OpenSolverFilesDirectory() (p. 177) Run the OpenSolverFilesDirectory action.
Method Solve(bool) (p. 177) Run the Solve action.
Method Solve(bool, string) (p. 177) Run the Solve action.
Method TransferDataFrom(Analysis) (p. 178) Transfer Data From action.
Method UnlinkDataFrom(Analysis) (p. 178) Unlink Data From action.
Method WriteSystemCouplingFiles(string) (p. 178) Writes the system coupling files. Usage
WriteSystemCouplingFiles("C:\\Desktop\\temp\\scp

Acoustics
Gets or sets the Acoustics.

Declaration Syntax
public bool Acoustics { set;get; }

AMProcessSimulation
Gets or sets the AMProcessSimulation.

Declaration Syntax
public AMProcessSimulationType AMProcessSimulation { set;get; }

AnalysisSettings
Gets the AnalysisSettings.

Declaration Syntax
public AnalysisSettings AnalysisSettings { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 153
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject> 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; }

EnvironmentTemperature
Gets or sets the EnvironmentTemperature.

Declaration Syntax
public Quantity EnvironmentTemperature { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
154 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerateInputOnly
Gets the GenerateInputOnly.

Declaration Syntax
public bool GenerateInputOnly { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InitialConditions
Get InitialConditions.

Declaration Syntax
public IList<InitialCondition> InitialConditions { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSEnvironmentAuto InternalObject { get; }

PhysicsType
Gets the PhysicsType.

Declaration Syntax
public PhysicsType PhysicsType { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 155
Ansys.ACT.Automation.Mechanical Namespace

Solution
Gets the Solution.

Declaration Syntax
public Solution Solution { get; }

Structural
Gets or sets the Structural.

Declaration Syntax
public bool Structural { set;get; }

SystemCaption
Gets the SystemCaption.

Declaration Syntax
public string SystemCaption { get; }

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
156 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

AddAcousticDiffuseSoundField()
Creates a new AcousticDiffuseSoundField

Declaration Syntax
public virtual AcousticDiffuseSoundField AddAcousticDiffuseSoundField()

AddAcousticFarFieldRadationSurface()
Creates a new AcousticFarFieldRadationSurface

Declaration Syntax
public virtual AcousticFarFieldRadationSurface AddAcousticFarFieldRadationSurface()

AddAcousticFreeSurface()
Creates a new AcousticFreeSurface

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 157
Ansys.ACT.Automation.Mechanical Namespace

AddAcousticLowReducedFrequency()
Creates a new AcousticLowReducedFrequency

Declaration Syntax
public virtual AcousticLowReducedFrequency AddAcousticLowReducedFrequency()

AddAcousticMassSource()
Creates a new AcousticMassSource

Declaration Syntax
public virtual AcousticMassSource AddAcousticMassSource()

AddAcousticPort()
Creates a new AcousticPort

Declaration Syntax
public virtual AcousticPort AddAcousticPort()

AddAcousticPortInDuct()
Creates a new AcousticPortInDuct

Declaration Syntax
public virtual AcousticPortInDuct AddAcousticPortInDuct()

AddAcousticPressure()
Creates a new AcousticPressure

Declaration Syntax
public virtual AcousticPressure AddAcousticPressure()

AddAcousticRadiationBoundary()
Creates a new AcousticRadiationBoundary

Declaration Syntax
public virtual AcousticRadiationBoundary AddAcousticRadiationBoundary()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
158 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

AddAcousticRigidWall()
Creates a new AcousticRigidWall

Declaration Syntax
public virtual AcousticRigidWall AddAcousticRigidWall()

AddAcousticStaticPressure()
Creates a new AcousticStaticPressure

Declaration Syntax
public virtual AcousticStaticPressure AddAcousticStaticPressure()

AddAcousticSurfaceVelocity()
Creates a new AcousticSurfaceVelocity

Declaration Syntax
public virtual AcousticSurfaceVelocity AddAcousticSurfaceVelocity()

AddAcousticSymmetryPlane()
Creates a new AcousticSymmetryPlane

Declaration Syntax
public virtual AcousticSymmetryPlane AddAcousticSymmetryPlane()

AddAcousticTemperature()
Creates a new child ThermalCondition.

Declaration Syntax
public virtual AcousticTemperature AddAcousticTemperature()

AddAcousticThermoViscousBLIBoundary()
Creates a new AcousticThermoViscousBLIBoundary

Declaration Syntax
public virtual AcousticThermoViscousBLIBoundary AddAcousticThermoViscousBLIBoundary()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 159
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual BoltPretension AddBoltPretension()

AddCenterOfGravityConstraint()
Creates a new CenterOfGravityConstraint

Declaration Syntax
public virtual CenterOfGravityConstraint AddCenterOfGravityConstraint()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
160 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

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

Declaration Syntax
public virtual ConstraintEquation AddConstraintEquation()

AddContactStepControl()
Creates a new ContactStepControl

Declaration Syntax
public virtual ContactStepControl AddContactStepControl()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 161
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual CyclicManufacturingConstraint AddCyclicManufacturingConstraint()

AddCylindricalSupport()
Creates a new CylindricalSupport

Declaration Syntax
public virtual CylindricalSupport AddCylindricalSupport()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
162 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

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()

AddEarthGravity()
Creates a new EarthGravity

Declaration Syntax
public virtual EarthGravity AddEarthGravity()

AddElasticSupport()
Creates a new ElasticSupport

Declaration Syntax
public virtual ElasticSupport AddElasticSupport()

AddElementBirthAndDeath()
Creates a new ElementBirthAndDeath

Declaration Syntax
public virtual ElementBirthAndDeath AddElementBirthAndDeath()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 163
Ansys.ACT.Automation.Mechanical Namespace

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.

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
164 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 165
Ansys.ACT.Automation.Mechanical Namespace

AddHydrostaticPressure()
Creates a new HydrostaticPressure

Declaration Syntax
public virtual HydrostaticPressure AddHydrostaticPressure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

AddImpedanceBoundary()
Creates a new ImpedanceBoundary

Declaration Syntax
public virtual ImpedanceBoundary AddImpedanceBoundary()

AddImportedLoadResultFile()
Creates a new Import Load (Result File).

Declaration Syntax
public virtual ImportedLoadGroup AddImportedLoadResultFile()

AddInitialVelocity()
Creates a new child Initial Velocity.

Declaration Syntax
public virtual InitialCondition AddInitialVelocity()

AddInternalHeatGeneration()
Creates a new InternalHeatGeneration

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
166 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual InternalHeatGeneration AddInternalHeatGeneration()

AddJointLoad()
Creates a new JointLoad

Declaration Syntax
public virtual JointLoad AddJointLoad()

AddLinePressure()
Creates a new LinePressure

Declaration Syntax
public virtual LinePressure AddLinePressure()

AddLocalVonMisesStressConstraint()
Creates a new LocalVonMisesStressConstraint

Declaration Syntax
public virtual LocalVonMisesStressConstraint AddLocalVonMisesStressConstraint()

AddMagneticFluxParallel()
Creates a new MagneticFluxParallel

Declaration Syntax
public virtual MagneticFluxParallel AddMagneticFluxParallel()

AddMassConstraint()
Creates a new MassConstraint

Declaration Syntax
public virtual MassConstraint AddMassConstraint()

AddMassFlowRate()
Creates a new MassFlowRate

Release 2020 R1 - © 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 MassFlowRate AddMassFlowRate()

AddMemberSizeManufacturingConstraint()
Creates a new MemberSizeManufacturingConstraint

Declaration Syntax
public virtual MemberSizeManufacturingConstraint AddMemberSizeManufacturingConstraint()

AddMoment()
Creates a new Moment

Declaration Syntax
public virtual Moment AddMoment()

AddMomentOfInertiaConstraint()
Creates a new MomentOfInertiaConstraint

Declaration Syntax
public virtual MomentOfInertiaConstraint AddMomentOfInertiaConstraint()

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
168 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual NodalForce AddNodalForce()

AddNodalOrientation()
Creates a new NodalOrientation

Declaration Syntax
public virtual NodalOrientation AddNodalOrientation()

AddNodalPressure()
Creates a new NodalPressure

Declaration Syntax
public virtual NodalPressure AddNodalPressure()

AddNodalRotation()
Creates a new NodalRotation

Declaration Syntax
public virtual NodalRotation AddNodalRotation()

AddNonlinearAdaptiveRegion()
Creates a new NonlinearAdaptiveRegion

Declaration Syntax
public virtual NonlinearAdaptiveRegion AddNonlinearAdaptiveRegion()

AddObjective()
Creates a new Objective

Declaration Syntax
public virtual Objective AddObjective()

AddOptimizationRegion()
Creates a new OptimizationRegion

Release 2020 R1 - © 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 OptimizationRegion AddOptimizationRegion()

AddPerfectlyInsulated()
Creates a new PerfectlyInsulated

Declaration Syntax
public virtual PerfectlyInsulated AddPerfectlyInsulated()

AddPhysicsRegion()
Creates a new PhysicsRegion

Declaration Syntax
public virtual PhysicsRegion AddPhysicsRegion()

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
170 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual Pressure AddPressure()

AddPSDAcceleration()
Creates a new PSDAcceleration

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()

AddRadiation()
Creates a new Radiation

Release 2020 R1 - © 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 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
172 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

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()

AddSymmetryManufacturingConstraint()
Creates a new SymmetryManufacturingConstraint

Release 2020 R1 - © 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 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()

AddThermalCondition()
Creates a new child ThermalCondition.

Declaration Syntax
public virtual ThermalCondition AddThermalCondition()

AddVelocity()
Creates a new Velocity

Declaration Syntax
public virtual Velocity AddVelocity()

AddViscoelasticHeating()
Creates a new ViscoelasticHeating

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
174 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual ViscoelasticHeating AddViscoelasticHeating()

AddVoltage()
Creates a new Voltage

Declaration Syntax
public virtual Voltage AddVoltage()

AddVolumeConstraint()
Creates a new VolumeConstraint

Declaration Syntax
public virtual VolumeConstraint AddVolumeConstraint()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateAutomaticFarFieldRadiationSurfaces()
Run the CreateAutomaticEquivalentSourceSurfaces action.

Declaration Syntax
public virtual void CreateAutomaticFarFieldRadiationSurfaces()

CreateAutomaticFSI()
Run the CreateAutomaticFSI action.

Declaration Syntax
public virtual void CreateAutomaticFSI()

CreateAutomaticFSIandFarFieldRadiationSurfaces()
Run the CreateAutomaticFSIandEquivalentSourceSurfaces action.

Release 2020 R1 - © 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 void CreateAutomaticFSIandFarFieldRadiationSurfaces()

ExportNastranFile(NastranExportOptions)
Export Nastran File.

Declaration Syntax
public virtual void ExportNastranFile(NastranExportOptions exportOptions)

Parameters
exportOptions(NastranExportOptions)
Export options.

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
176 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ImportLoad(Analysis)
Import Load action.

Declaration Syntax
public virtual void ImportLoad(Analysis analysis)

Parameters
analysis(Analysis)
Analysis system.

OpenSolverFilesDirectory()
Run the OpenSolverFilesDirectory action.

Declaration Syntax
public virtual void OpenSolverFilesDirectory()

Solve(bool)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait)

Parameters
wait(bool)
Wait or not for the solve to be done.

Solve(bool, string)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, string config)

Parameters
wait(bool)
Wait or not for the solve to be done.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 177
Ansys.ACT.Automation.Mechanical Namespace

config(string)
The solve configuration to use. Will throw an error if the input solve configuration does not exist. If none
is provided, the default is used for the solve.

TransferDataFrom(Analysis)
Transfer Data From action.

Declaration Syntax
public virtual void TransferDataFrom(Analysis analysis)

Parameters
analysis(Analysis)
Analysis system.

UnlinkDataFrom(Analysis)
Unlink Data From action.

Declaration Syntax
public virtual void UnlinkDataFrom(Analysis analysis)

Parameters
analysis(Analysis)
Analysis system.

WriteSystemCouplingFiles(string)
Writes the system coupling files. Usage WriteSystemCouplingFiles("C:\\Desktop\\temp\\scp1.scp");

Declaration Syntax
public virtual void WriteSystemCouplingFiles(string filename)

Parameters
filename(string)
No details are provided for this entry.

AnalysisPly
Defines a AnalysisPly.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
178 of ANSYS, Inc. and its subsidiaries and affiliates.
AnalysisPly

Declaration Syntax
public class AnalysisPly : DataModelObject, IFolderDataModelObject

Table 105: Members

Property Angle (p. 179) Gets or sets the Angle.


Property Children (p. 179) Gets the list of children.
Property Comments (p. 180) Gets the list of associated comments.
Property DataModelObjectCategory (p. 180) Gets the current DataModelObject's category.
Property Figures (p. 180) Gets the list of associated figures.
Property IDInSource (p. 180) Gets the IDInSource.
Property Images (p. 180) Gets the list of associated images.
Property InternalObject (p. 180) Gets the internal object. For advanced usage only.
Property Material (p. 181) Gets the Material.
Property NameInSource (p. 181) Gets the NameInSource.
Property NumberOfElements (p. 181) Gets the NumberOfElements.
Property Thickness (p. 181) Gets the Thickness.
Method AddComment() (p. 181) Creates a new child Comment.
Method AddFigure() (p. 181) Creates a new child Figure.
Method AddImage(string) (p. 182) Creates a new child Image. If a 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. 182)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 182)

Angle
Gets or sets the Angle.

Declaration Syntax
public Quantity Angle { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 179
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; }

IDInSource
Gets the IDInSource.

Declaration Syntax
public string IDInSource { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSAnalysisPlyAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
180 of ANSYS, Inc. and its subsidiaries and affiliates.
AnalysisPly

Material
Gets the Material.

Declaration Syntax
public string Material { get; }

NameInSource
Gets the NameInSource.

Declaration Syntax
public string NameInSource { get; }

NumberOfElements
Gets the NumberOfElements.

Declaration Syntax
public uint NumberOfElements { get; }

Thickness
Gets the Thickness.

Declaration Syntax
public Quantity Thickness { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 181
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.

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
182 of ANSYS, Inc. and its subsidiaries and affiliates.
ArbitraryCrack

ArbitraryCrack
Defines a ArbitraryCrack.

Declaration Syntax
public class ArbitraryCrack : GenericCrack

Table 106: Members

Property BottomFaceNodes (p. 184) Gets or sets the BottomFaceNodes.


Property Children (p. 347) Gets the list of children.

(Inherited from GenericCrack (p. 347).)


Property CircumferentialDivisions (p. 184) Gets or sets the CircumferentialDivisions.
Property Comments (p. 348) Gets the list of associated comments.

(Inherited from GenericCrack (p. 347).)


Property CoordinateSystem (p. 184) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 184) Gets or sets the CrackFacesNodes.
Property CrackFrontNodes (p. 184) Gets or sets the CrackFrontNodes.
Property CrackMeshMethod (p. 184) Gets the CrackMeshMethod.
Property CrackShape (p. 185) Gets the CrackShape.
Property CrackSourceType (p. 185) Gets the CrackSourceType.
Property CrackSurfaceLocation (p. 185) Gets or sets the CrackSurfaceLocation.
Property DataModelObjectCategory (p. 185) Gets the current DataModelObject's
category.
Property Figures (p. 348) Gets the list of associated figures.

(Inherited from GenericCrack (p. 347).)


Property FrontElementSize (p. 185) Gets or sets the FrontElementSize.
Property GrowthRate (p. 185) Gets or sets the GrowthRate.
Property Images (p. 348) Gets the list of associated images.

(Inherited from GenericCrack (p. 347).)


Property InternalObject (p. 186) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 186) Gets or sets the LargestContourRadius.
Property Location (p. 186) Gets or sets the Location.
Property MeshContours (p. 186) Gets or sets the MeshContours.
Property SolutionContours (p. 186) Gets or sets the SolutionContours.
Property Suppressed (p. 186) Gets or sets the Suppressed.
Property TopFaceNodes (p. 187) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 187) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 187) Gets or sets the YScaleFactor.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 183
Ansys.ACT.Automation.Mechanical Namespace

Property ZScaleFactor (p. 187) 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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
184 of ANSYS, Inc. and its subsidiaries and affiliates.
ArbitraryCrack

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

CrackSurfaceLocation
Gets or sets the CrackSurfaceLocation.

Declaration Syntax
public ISelectionInfo CrackSurfaceLocation { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 185
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
186 of ANSYS, Inc. and its subsidiaries and affiliates.
BatchConnectionsWorksheet

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; }

BatchConnectionsWorksheet
No details are provided for this entry.

Declaration Syntax
public class BatchConnectionsWorksheet : Worksheet

Table 107: Members

Property RowCount (p. 188) Gets the number of entries


Method AddRow() (p. 188) Add a row to the MeshControlWorksheet
Method ClearGenerateMesh() (p. 188) Clear Mesh
Method DeleteAllRows() (p. 188) Delete All Rows
Method DeleteRow(int) (p. 189) Delete a row from the MeshControlWorksheet
Method GenerateAtRow(int) (p. 189) Generate Mesh At Row

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 187
Ansys.ACT.Automation.Mechanical Namespace

Method GenerateMesh() (p. 189) Geneate Mesh


Method GetActiveState(int) (p. 189) Gets the Active State property at row index
Method GetConnectionOption(int) (p. 190) Gets the current set cconnection option at
the row index
Method GetConnectionTolerances(int) (p. 190) Gets the list of connection tolerances at the
row index
Method GetNamedSelection(int) (p. 190) Gets the NamedSelection at row index
Method GetNamedSelectionId(int) (p. 190) Gets the ID of the NamedSelection at row
index
Method SetActiveState(int, bool) (p. 191) Sets the Active State property at row index
Method SetConnectionOption(int, int) (p. 191) Sets the connection option at row index
Method SetConnectionTolerances(int, string) (p. 191) Sets the connection tolerance list at row
index
Method SetNamedSelection(int, Sets the NamedSelection at row index
NamedSelection) (p. 192)
Method SetNamedSelectionId(int, uint) (p. 192) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
188 of ANSYS, Inc. and its subsidiaries and affiliates.
BatchConnectionsWorksheet

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 189
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)
No details are provided for this entry.

GetConnectionOption(int)
Gets the current set cconnection option at the row index

Declaration Syntax
public virtual int GetConnectionOption(int index)

Parameters
index(int)
No details are provided for this entry.

GetConnectionTolerances(int)
Gets the list of connection tolerances at the row index

Declaration Syntax
public virtual string GetConnectionTolerances(int index)

Parameters
index(int)
No details are provided for this entry.

GetNamedSelection(int)
Gets the NamedSelection at row index

Declaration Syntax
public virtual NamedSelection GetNamedSelection(int index)

Parameters
index(int)
No details are provided for this entry.

GetNamedSelectionId(int)
Gets the ID of the NamedSelection at row index

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
190 of ANSYS, Inc. and its subsidiaries and affiliates.
BatchConnectionsWorksheet

Declaration Syntax
public virtual uint GetNamedSelectionId(int index)

Parameters
index(int)
No details are provided for this entry.

SetActiveState(int, bool)
Sets the Active State property at row index

Declaration Syntax
public virtual void SetActiveState(int index, bool value)

Parameters
index(int)
No details are provided for this entry.

value(bool)
No details are provided for this entry.

SetConnectionOption(int, int)
Sets the connection option at row index

Declaration Syntax
public virtual void SetConnectionOption(int index, int value)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 191
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)
No details are provided for this entry.

value(string)
No details are provided for this entry.

SetNamedSelection(int, NamedSelection)
Sets the NamedSelection at row index

Declaration Syntax
public virtual void SetNamedSelection(int index, NamedSelection value)

Parameters
index(int)
No details are provided for this entry.

value(NamedSelection)
No details are provided for this entry.

SetNamedSelectionId(int, uint)
Sets the NamedSelection by ID at row index

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
192 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public class Body : DataModelObject, IFolderDataModelObject

Table 108: Members

Property Assignment ***OBSOLETE*** Use Gets or sets the Assignment.


'Material' property instead. (p. 195)
Property Average (p. 195) Gets the Average.
Property BeamSection (p. 195) Gets the BeamSection.
Property Behavior (p. 195) Gets or sets the Behavior.
Property BrickIntegrationScheme (p. 196) Gets or sets the BrickIntegrationScheme.
Property CentroidX (p. 196) Gets the CentroidX.
Property CentroidY (p. 196) Gets the CentroidY.
Property CentroidZ (p. 196) Gets the CentroidZ.
Property Children (p. 196) Gets the list of children.
Property Comments (p. 196) Gets the list of associated comments.
Property CoordinateSystem (p. 197) Gets or sets the CoordinateSystem.
Property CrossSectionArea (p. 197) Gets the CrossSectionArea.
Property CrossSectionIYY (p. 197) Gets the CrossSectionIYY.
Property CrossSectionIZZ (p. 197) Gets the CrossSectionIZZ.
Property CrossSectionName (p. 197) Gets CrossSectionName.
Property CrossSectionSelection (p. 197) Gets or sets the CrossSectionSelection.
Property DataModelObjectCategory (p. 198) Gets the current DataModelObject's category.
Property Dimension (p. 198) Gets or sets the Dimension.
Property Elements (p. 198) Gets the Elements.
Property Figures (p. 198) Gets the list of associated figures.
Property FluidCrossArea (p. 198) Gets or sets the FluidCrossArea.
Property FluidDiscretization (p. 198) Gets or sets the FluidDiscretization.
Property FluidSolidPhase (p. 199) Gets or sets the FluidSolidPhase.
Property Hidden (p. 199) Hide or show the body.
Property Images (p. 199) Gets the list of associated images.
Property InternalObject (p. 199) Gets the internal object. For advanced usage only.
Property IsWindingBody (p. 199) Gets the IsWindingBody.
Property Length (p. 199) Gets the Length.
Property LengthX (p. 200) Gets the LengthX.
Property LengthY (p. 200) Gets the LengthY.
Property LengthZ (p. 200) Gets the LengthZ.
Property LinkTrussBehavior (p. 200) Gets or sets the LinkTrussBehavior.
Property ManualThicknessMode (p. 200) Gets the ManualThicknessMode.
Property Mass (p. 200) Gets the Mass.
Property Material (p. 201) Gets or sets the Material.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 193
Ansys.ACT.Automation.Mechanical Namespace

Property Maximum (p. 201) Gets the Maximum.


Property MeshMetric (p. 201) Gets the MeshMetric.
Property MeshVersion (p. 201) Gets the MeshVersion.
Property Minimum (p. 201) Gets the Minimum.
Property ModelType (p. 201) Gets or sets the ModelType.
Property MomentOfInertiaIp1 (p. 202) Gets the MomentOfInertiaIp1.
Property MomentOfInertiaIp2 (p. 202) Gets the MomentOfInertiaIp2.
Property MomentOfInertiaIp3 (p. 202) Gets the MomentOfInertiaIp3.
Property Nodes (p. 202) Gets the Nodes.
Property NonlinearEffects (p. 202) Gets or sets the NonlinearEffects.
Property NumberOfTurns (p. 202) Gets or sets the NumberOfTurns.
Property OffsetMode (p. 203) Gets or sets the OffsetMode.
Property OffsetType (p. 203) Gets or sets the OffsetType.
Property OffsetX (p. 203) Gets or sets the OffsetX.
Property OffsetY (p. 203) Gets or sets the OffsetY.
Property PipeExternalDiameter (p. 203) Gets the PipeExternalDiameter.
Property PipeInternalDiameter (p. 203) Gets the PipeInternalDiameter.
Property PipeThickness (p. 204) Gets the PipeThickness.
Property ReadOnly (p. 204) Gets the ReadOnly.
Property ReferenceFrame (p. 204) Gets or sets the ReferenceFrame.
Property ReferenceTemperature ***OBSOLETE*** Gets or sets the ReferenceTemperature.
Use 'UseReferenceTemperatureByBody'
property instead. (p. 204)
Property ReferenceTemperatureValue (p. 204) Gets or sets the ReferenceTemperatureValue.
Property ShellOffsetType (p. 204) Gets or sets the ShellOffsetType.
Property StandardDeviation (p. 205) Gets the StandardDeviation.
Property StiffnessBehavior (p. 205) Gets or sets the StiffnessBehavior.
Property Suppressed (p. 205) Gets or sets the Suppressed.
Property SurfaceArea (p. 205) Gets the SurfaceArea.
Property ThermalStrainEffects (p. 205) Gets or sets the ThermalStrainEffects.
Property Thickness (p. 205) Gets or sets the Thickness.
Property ThicknessMode ***OBSOLETE*** Use Gets the ThicknessMode.
'ManualThicknessMode' property
instead. (p. 206)
Property Treatment (p. 206) Gets or sets the Treatment.
Property UseReferenceTemperatureByBody (p. 206) Gets or sets the UseReferenceTemperatureByBody.
Property UserNameChange (p. 206) Gets the UserNameChange.
Property Visible (p. 206) Gets or sets the Visible.
Property Volume (p. 206) Gets the Volume.
Method AddCommandSnippet() (p. 207) Creates a new CommandSnippet

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
194 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Method AddComment() (p. 207) Creates a new child Comment.


Method AddFigure() (p. 207) Creates a new child Figure.
Method AddImage(string) (p. 207) Creates a new child Image. If a 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. 207) Run the ClearGeneratedData action.
Method GenerateMesh() (p. 208) Run the GenerateMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 208)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 208)
Method GetGeoBody() (p. 208) Gets the Geo Body
Method PreviewInflation() (p. 209) Run the PreviewInflation action.
Method PreviewSurfaceMesh() (p. 209) Run the PreviewSurfaceMesh action.
Method ShowBody() (p. 209) Run the ShowBody action.
Method Update() (p. 209) Run the Update action.

Assignment ***OBSOLETE*** Use 'Material' property instead.


Gets or sets the Assignment.

Declaration Syntax
public string Assignment { set;get; }

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

BeamSection
Gets the BeamSection.

Declaration Syntax
public DataModelObject BeamSection { get; }

Behavior
Gets or sets the Behavior.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 195
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public Quantity CentroidZ { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
196 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrossSectionArea
Gets the CrossSectionArea.

Declaration Syntax
public Quantity CrossSectionArea { get; }

CrossSectionIYY
Gets the CrossSectionIYY.

Declaration Syntax
public Quantity CrossSectionIYY { get; }

CrossSectionIZZ
Gets the CrossSectionIZZ.

Declaration Syntax
public Quantity CrossSectionIZZ { get; }

CrossSectionName
Gets CrossSectionName.

Declaration Syntax
public string CrossSectionName { get; }

CrossSectionSelection
Gets or sets the CrossSectionSelection.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 197
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CrossSection CrossSectionSelection { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Dimension
Gets or sets the Dimension.

Declaration Syntax
public ShellBodyDimension Dimension { set;get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
198 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public FluidDiscretizationType FluidDiscretization { set;get; }

FluidSolidPhase
Gets or sets the FluidSolidPhase.

Declaration Syntax
public PhaseType FluidSolidPhase { set;get; }

Hidden
Hide or show the body.

Declaration Syntax
public bool Hidden { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPrototypeAuto InternalObject { get; }

IsWindingBody
Gets the IsWindingBody.

Declaration Syntax
public bool IsWindingBody { get; }

Length
Gets the Length.

Release 2020 R1 - © 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 Length { get; }

LengthX
Gets the LengthX.

Declaration Syntax
public Quantity LengthX { get; }

LengthY
Gets the LengthY.

Declaration Syntax
public Quantity LengthY { get; }

LengthZ
Gets the LengthZ.

Declaration Syntax
public Quantity LengthZ { get; }

LinkTrussBehavior
Gets or sets the LinkTrussBehavior.

Declaration Syntax
public PrototypeLinkBehavior LinkTrussBehavior { set;get; }

ManualThicknessMode
Gets the ManualThicknessMode.

Declaration Syntax
public bool ManualThicknessMode { get; }

Mass
Gets the Mass.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
200 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public Quantity Mass { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

MeshMetric
Gets the MeshMetric.

Declaration Syntax
public int MeshMetric { get; }

MeshVersion
Gets the MeshVersion.

Declaration Syntax
public int MeshVersion { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

ModelType
Gets or sets the ModelType.

Release 2020 R1 - © 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 PrototypeModelType ModelType { set;get; }

MomentOfInertiaIp1
Gets the MomentOfInertiaIp1.

Declaration Syntax
public Quantity MomentOfInertiaIp1 { get; }

MomentOfInertiaIp2
Gets the MomentOfInertiaIp2.

Declaration Syntax
public Quantity MomentOfInertiaIp2 { get; }

MomentOfInertiaIp3
Gets the MomentOfInertiaIp3.

Declaration Syntax
public Quantity MomentOfInertiaIp3 { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

NonlinearEffects
Gets or sets the NonlinearEffects.

Declaration Syntax
public bool NonlinearEffects { set;get; }

NumberOfTurns
Gets or sets the NumberOfTurns.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
202 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public uint NumberOfTurns { set;get; }

OffsetMode
Gets or sets the OffsetMode.

Declaration Syntax
public AutomaticOrManual OffsetMode { set;get; }

OffsetType
Gets or sets the OffsetType.

Declaration Syntax
public BeamOffsetType OffsetType { set;get; }

OffsetX
Gets or sets the OffsetX.

Declaration Syntax
public Quantity OffsetX { set;get; }

OffsetY
Gets or sets the OffsetY.

Declaration Syntax
public Quantity OffsetY { set;get; }

PipeExternalDiameter
Gets the PipeExternalDiameter.

Declaration Syntax
public Quantity PipeExternalDiameter { get; }

PipeInternalDiameter
Gets the PipeInternalDiameter.

Release 2020 R1 - © 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 Quantity PipeInternalDiameter { get; }

PipeThickness
Gets the PipeThickness.

Declaration Syntax
public Quantity PipeThickness { get; }

ReadOnly
Gets the ReadOnly.

Declaration Syntax
public bool ReadOnly { get; }

ReferenceFrame
Gets or sets the ReferenceFrame.

Declaration Syntax
public ReferenceFrameType ReferenceFrame { set;get; }

ReferenceTemperature ***OBSOLETE*** Use 'UseReferenceTemperatureBy-


Body' property instead.
Gets or sets the ReferenceTemperature.

Declaration Syntax
public bool ReferenceTemperature { set;get; }

ReferenceTemperatureValue
Gets or sets the ReferenceTemperatureValue.

Declaration Syntax
public Quantity ReferenceTemperatureValue { set;get; }

ShellOffsetType
Gets or sets the ShellOffsetType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
204 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

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; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;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.

Release 2020 R1 - © 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 Quantity Thickness { set;get; }

ThicknessMode ***OBSOLETE*** Use 'ManualThicknessMode' property in-


stead.
Gets the ThicknessMode.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
206 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public Quantity Volume { 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)

Parameters
filePath(string)
Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 207
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetGeoBody()
Gets the Geo Body

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
208 of ANSYS, Inc. and its subsidiaries and affiliates.
CenterOfGravityConstraint

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.

Declaration Syntax
public class CenterOfGravityConstraint : DataModelObject

Table 109: Members

Property Axis (p. 210) Gets or sets the Axis.


Property DataModelObjectCategory (p. 210) Gets the current DataModelObject's
category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 209
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 210) Gets the internal object. For advanced usage
only.
Property MaximumPosition (p. 210) Gets or sets the MaximumPosition.
Property MnimumPosition (p. 210) Gets or sets the MnimumPosition.
Property Suppressed (p. 211) Gets or sets the Suppressed.
Method Delete() (p. 211) Run the Delete action.

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.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

MaximumPosition
Gets or sets the MaximumPosition.

Declaration Syntax
public Quantity MaximumPosition { set;get; }

MnimumPosition
Gets or sets the MnimumPosition.

Declaration Syntax
public Quantity MnimumPosition { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
210 of ANSYS, Inc. and its subsidiaries and affiliates.
Chart

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Chart
Defines a Chart.

Declaration Syntax
public class Chart : DataModelObject, IFolderDataModelObject

Table 110: Members

Property Caption (p. 212) Gets or sets the Caption.


Property Children (p. 212) Gets the list of children.
Property Comments (p. 212) Gets the list of associated comments.
Property Content (p. 212) Gets or sets the Content.
Property DataModelObjectCategory (p. 212) Gets the current DataModelObject's category.
Property Gridlines (p. 213) Gets or sets the Gridlines.
Property Images (p. 213) Gets the list of associated images.
Property InternalObject (p. 213) Gets the internal object. For advanced usage only.
Property ModalDisplayType (p. 213) Gets or sets the ModalDisplayType.
Property OutlineSelection (p. 213) Gets or sets the OutlineSelection.
Property PlotStyle (p. 213) Gets or sets the PlotStyle.
Property Scale (p. 214) Gets or sets the Scale.
Property XAxis (p. 214) Use to control the X Axis property of the chart.
Property XAxisLabel (p. 214) Gets or sets the XAxisLabel.
Property YAxisLabel (p. 214) Gets or sets the YAxisLabel.
Method AddComment() (p. 214) Creates a new child Comment.
Method AddImage(string) (p. 214) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 211
Ansys.ACT.Automation.Mechanical Namespace

image will be a screen capture of the Geometry


window.
Method Delete() (p. 215) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 215)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 215)

Caption
Gets or sets the Caption.

Declaration Syntax
public string Caption { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Content
Gets or sets the Content.

Declaration Syntax
public ChartReportType Content { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
212 of ANSYS, Inc. and its subsidiaries and affiliates.
Chart

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.

Declaration Syntax
public IEnumerable<DataModelObject> OutlineSelection { set;get; }

PlotStyle
Gets or sets the PlotStyle.

Declaration Syntax
public ChartPlotStyle PlotStyle { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 213
Ansys.ACT.Automation.Mechanical Namespace

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.

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
214 of ANSYS, Inc. and its subsidiaries and affiliates.
Chart

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 215
Ansys.ACT.Automation.Mechanical Namespace

ChartXAxis
No details are provided for this entry.

Declaration Syntax
public class ChartXAxis

Table 111: Members

Property ComponentIndex (p. 216) Gets or sets the component index for the chart.
Property ObjectSelection (p. 216) 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; }

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 DataModelObject ObjectSelection { set;get; }

CommandSnippet
Defines a CommandSnippet.

Declaration Syntax
public class CommandSnippet : DataModelObject, IFolderDataModelObject

Table 112: Members

Property Children (p. 217) Gets the list of children.


Property Comments (p. 218) Gets the list of associated comments.
Property DataModelObjectCategory (p. 218) Gets the current DataModelObject's category.
Property Figures (p. 218) Gets the list of associated figures.
Property FileName (p. 218) Gets the FileName.
Property Images (p. 218) Gets the list of associated images.
Property Input (p. 218) Gets or sets the Text.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
216 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

Property InputArgument1 (p. 219) Gets or sets the InputArgument1.


Property InputArgument2 (p. 219) Gets or sets the InputArgument2.
Property InputArgument3 (p. 219) Gets or sets the InputArgument3.
Property InputArgument4 (p. 219) Gets or sets the InputArgument4.
Property InputArgument5 (p. 219) Gets or sets the InputArgument5.
Property InputArgument6 (p. 219) Gets or sets the InputArgument6.
Property InputArgument7 (p. 220) Gets or sets the InputArgument7.
Property InputArgument8 (p. 220) Gets or sets the InputArgument8.
Property InputArgument9 (p. 220) Gets or sets the InputArgument9.
Property InternalObject (p. 220) Gets the internal object. For advanced usage only.
Property InvalidateSolution (p. 220) Gets or sets the InvalidateSolution.
Property OutputParameters (p. 220) Gets a list of the command snippet's output
parameters.
Property OutputSearchPrefix (p. 221) Gets or sets the OutputSearchPrefix.
Property SnippetFileStatus (p. 221) Gets the SnippetFileStatus.
Property SolverTarget (p. 221) Gets the SolverTarget.
Property StepNumber (p. 221) Gets or sets the StepNumber.
Property StepSelectionMode (p. 221) Gets or sets the StepSelectionMode.
Property Suppressed (p. 221) Gets or sets the Suppressed.
Method AddComment() (p. 222) Creates a new child Comment.
Method AddFigure() (p. 222) Creates a new child Figure.
Method AddImage(string) (p. 222) Creates a new child Image. If a 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. 222) Append Text.
Method Delete() (p. 222) Run the Delete action.
Method ExportTextFile(string) (p. 223) Export to Textfile.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 223)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 223)
Method ImportTextFile(string) (p. 224) Import from Textfile.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 217
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; }

FileName
Gets the FileName.

Declaration Syntax
public string FileName { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

Input
Gets or sets the Text.

Declaration Syntax
public string Input { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
218 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

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; }

InputArgument6
Gets or sets the InputArgument6.

Declaration Syntax
public string InputArgument6 { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 219
Ansys.ACT.Automation.Mechanical Namespace

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; }

OutputParameters
Gets a list of the command snippet's output parameters.

Declaration Syntax
public IReadOnlyList<CommandOutputParameter> OutputParameters { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
220 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 221
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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
222 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

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)

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 223
Ansys.ACT.Automation.Mechanical Namespace

children(IList<DataModelObject>)
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.

Comment
Defines a Comment.

Declaration Syntax
public class Comment : DataModelObject, IFolderDataModelObject

Table 113: Members

Property Author (p. 224) Gets or sets the Author.


Property Children (p. 225) Gets the list of children.
Property DataModelObjectCategory (p. 225) Gets the current DataModelObject's
category.
Property InternalObject (p. 225) Gets the internal object. For advanced
usage only.
Property Text (p. 225) Gets the Text.
Method Delete() (p. 225) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 225)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 226)

Author
Gets or sets the Author.

Declaration Syntax
public string Author { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
224 of ANSYS, Inc. and its subsidiaries and affiliates.
Comment

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 225
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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject

Table 114: Members

Property ComplianceLimit (p. 226) Gets or sets the ComplianceLimit.


Property DataModelObjectCategory (p. 227) Gets the current DataModelObject's
category.
Property InternalObject (p. 227) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 227) Gets or sets the Suppressed.
Method Delete() (p. 227) Run the Delete action.

ComplianceLimit
Gets or sets the ComplianceLimit.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
226 of ANSYS, Inc. and its subsidiaries and affiliates.
CompositeCriterion

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; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

CompositeCriterion
Defines a CompositeCriterion.

Declaration Syntax
public class CompositeCriterion : Criterion

Table 115: Members

Property Children (p. 283) Gets the list of children.

(Inherited from Criterion (p. 282).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 227
Ansys.ACT.Automation.Mechanical Namespace

Property Comments (p. 283) Gets the list of associated comments.

(Inherited from Criterion (p. 282).)


Property DataModelObjectCategory (p. 228)Gets the current DataModelObject's category.
Property Figures (p. 283) Gets the list of associated figures.

(Inherited from Criterion (p. 282).)


Property Images (p. 284) Gets the list of associated images.

(Inherited from Criterion (p. 282).)


Property InternalObject (p. 228) Gets the internal object. For advanced usage only.
Property Suppressed (p. 284) Gets or sets the Suppressed.

(Inherited from Criterion (p. 282).)


Property Value (p. 284) Gets the Value.

(Inherited from Criterion (p. 282).)


Method ClearGeneratedData() (p. 228) Run the ClearGeneratedData action.
Method EvaluateAllResults() (p. 229) Run the EvaluateAllResults action.
Method GetDefinition() (p. 229) 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; }

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
228 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 116: Members

Property Count (p. 229) Gives the number of CompositeCriterionTerms in the definition.
Property Item (p. 230) No details are provided for this entry.
Method Add(CompositeCriterionTerm) (p. 230) Adds a CompositeCriterionTerm at the end in the definition. Usage:
CriterionDefinition.Add(Ansys.ACT.Automation.Mechanical.Composit
1.3))
Method Clear() (p. 230) Clears all the CompositeCriterionTerms in the definition.
Method IndexOf(CompositeCriterionTerm) (p. 230) 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. 230) IndexOutOfRangeException for invalid index. Usage: CriterionDefinit
Ansys.ACT.Automation.Mechanical.CompositeCriterionTerm(primCrit
Method RemoveAt(int) (p. 231) Removes the CompositeCriterionTerm at a specified index in the de
IndexOutOfRangeException for invalid index.

Count
Gives the number of CompositeCriterionTerms in the definition.

Declaration Syntax
public int Count { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 229
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public CompositeCriterionTerm Item { set;get; }

Add(CompositeCriterionTerm)
Adds a CompositeCriterionTerm at the end in the definition. Usage: CriterionDefinition.Add(An-
sys.ACT.Automation.Mechanical.CompositeCriterionTerm(primCritObj, 1.3))

Declaration Syntax
public virtual void Add(CompositeCriterionTerm item)

Parameters
item(CompositeCriterionTerm)
No details are provided for this entry.

Clear()
Clears all the CompositeCriterionTerms in the definition.

Declaration Syntax
public virtual void Clear()

IndexOf(CompositeCriterionTerm)
Gives the index where the specified CompositeCriterionTerm exists in the definition. Returns -1 if the
term is not found in the definition.

Declaration Syntax
public virtual int IndexOf(CompositeCriterionTerm item)

Parameters
item(CompositeCriterionTerm)
No details are provided for this entry.

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))

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
230 of ANSYS, Inc. and its subsidiaries and affiliates.
CompositeCriterionTerm

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 117: Members

Constructor CompositeCriterionTerm() (p. 232) Creates and returns a new


CompositeCriterionTerm.
Constructor CompositeCriterionTerm(PrimaryCriterion, Returns a new CompositeCriterionTerm with
double) (p. 232) given inputs
Property Coefficient (p. 232) Returns coefficient of PrimaryCriterion in the
CompositeCriterionTerm.
Property PrimaryCriterion (p. 232) Returns PrimaryCriterion Object associated
with the CompositeCriterionTerm. Returns
None if no PrimaryCriterion Object is assigned
to CompositeCriterionTerm.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 231
Ansys.ACT.Automation.Mechanical Namespace

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; }

CondensedGeometry
Defines a CondensedGeometry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
232 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedGeometry

Declaration Syntax
public class CondensedGeometry : DataModelObject, IFolderDataModelObject

Table 118: Members

Property Children (p. 233) Gets the list of children.


Property Comments (p. 233) Gets the list of associated comments.
Property DataModelObjectCategory (p. 234) Gets the current DataModelObject's category.
Property Figures (p. 234) Gets the list of associated figures.
Property Images (p. 234) Gets the list of associated images.
Property InternalObject (p. 234) Gets the internal object. For advanced usage only.
Property SolverFilesDirectory (p. 234) Gets the SolverFilesDirectory.
Property TransparencyEnabled (p. 234) Gets or sets the TransparencyEnabled.
Method AddComment() (p. 235) Creates a new child Comment.
Method AddCondensedPart() (p. 235) Creates a new CondensedPart
Method AddCondensedPartInfoTool() (p. 235) Creates a new CondensedPartInfoTool
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 ClearGeneratedData() (p. 235) Run the ClearGeneratedData action.
Method Delete() (p. 236) Run the Delete action.
Method GenerateCondensedParts() (p. 236) Run the GenerateCondensedParts action.
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<DataModelObject>) (p. 236)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 233
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCondensedGeometryAuto InternalObject { get; }

SolverFilesDirectory
Gets the SolverFilesDirectory.

Declaration Syntax
public string SolverFilesDirectory { get; }

TransparencyEnabled
Gets or sets the TransparencyEnabled.

Declaration Syntax
public bool TransparencyEnabled { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
234 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedGeometry

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)

Parameters
filePath(string)
Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 235
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GenerateCondensedParts()
Run the GenerateCondensedParts action.

Declaration Syntax
public virtual void GenerateCondensedParts()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
236 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

CondensedPart
Defines a CondensedPart.

Declaration Syntax
public class CondensedPart : DataModelObject, IFolderDataModelObject

Table 119: Members

Property AttachmentMethod (p. 238) Gets or sets the AttachmentMethod.


Property Children (p. 238) Gets the list of children.
Property Comments (p. 238) Gets the list of associated comments.
Property DataModelObjectCategory (p. 238) Gets the current DataModelObject's category.
Property Figures (p. 239) Gets the list of associated figures.
Property FutureExpansion (p. 239) Gets or sets the FutureExpansion.
Property FutureIntent (p. 239) Gets or sets the FutureIntent.
Property GenerateDampingMatrix (p. 239) Gets or sets the GenerateDampingMatrix.
Property GeometrySelection (p. 239) Gets or sets the GeometrySelection.
Property Images (p. 239) Gets the list of associated images.
Property InterfaceMethod (p. 240) Gets or sets the InterfaceMethod.
Property InternalObject (p. 240) Gets the internal object. For advanced usage only.
Property MaximumFrequency (p. 240) Gets or sets the MaximumFrequency.
Property MinimumFrequency (p. 240) Gets or sets the MinimumFrequency.
Property NumberInterfaceEntries (p. 240) Gets the NumberInterfaceEntries.
Property NumberMasterNodes (p. 240) Gets the NumberMasterNodes.
Property NumberOfModes (p. 241) Gets or sets the NumberOfModes.
Property Physics (p. 241) Gets the Physics.
Property RangeSearch (p. 241) Gets or sets the RangeSearch.
Property ReductionMethod (p. 241) Gets or sets the ReductionMethod.
Property ReferenceTemperature (p. 241) Gets or sets the ReferenceTemperature.
Property SolutionName (p. 241) Gets or sets the SolutionName.
Property SolutionNameMode (p. 242) Gets or sets the SolutionNameMode.
Property SolverFilesDirectory (p. 242) Gets the SolverFilesDirectory.
Property SolverType (p. 242) Gets or sets the SolverType.
Property SolverUnits (p. 242) Gets or sets the SolverUnits.
Property StoreBasisResults (p. 242) Gets or sets the StoreBasisResults.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 237
Ansys.ACT.Automation.Mechanical Namespace

Property Suppressed (p. 242) Gets or sets the Suppressed.


Property TemperatureUnits (p. 243) Gets the TemperatureUnits.
Method AddComment() (p. 243) Creates a new child Comment.
Method AddFigure() (p. 243) Creates a new child Figure.
Method AddImage(string) (p. 243) Creates a new child Image. If a 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. 243) Run the ClearGeneratedData action.
Method Delete() (p. 244) Run the Delete action.
Method DetectCondensedPartInterface() (p. 244) Run the DetectCondensedPartInterface action.
Method GenerateCondensedParts() (p. 244) Run the GenerateCondensedParts action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 244)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 244)

AttachmentMethod
Gets or sets the AttachmentMethod.

Declaration Syntax
public CondensedPartCMSAttachmentMethod AttachmentMethod { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
238 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { 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; }

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

Images
Gets the list of associated images.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 239
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InterfaceMethod
Gets or sets the InterfaceMethod.

Declaration Syntax
public CondensedPartInterfaceMethod InterfaceMethod { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCondensedPartAuto InternalObject { get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

NumberInterfaceEntries
Gets the NumberInterfaceEntries.

Declaration Syntax
public int NumberInterfaceEntries { get; }

NumberMasterNodes
Gets the NumberMasterNodes.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
240 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

Declaration Syntax
public int NumberMasterNodes { get; }

NumberOfModes
Gets or sets the NumberOfModes.

Declaration Syntax
public int NumberOfModes { set;get; }

Physics
Gets the Physics.

Declaration Syntax
public CondensedPartPhysics Physics { 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; }

ReferenceTemperature
Gets or sets the ReferenceTemperature.

Declaration Syntax
public Quantity ReferenceTemperature { set;get; }

SolutionName
Gets or sets the SolutionName.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 241
Ansys.ACT.Automation.Mechanical Namespace

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; }

SolverType
Gets or sets the SolverType.

Declaration Syntax
public SolverType SolverType { set;get; }

SolverUnits
Gets or sets the SolverUnits.

Declaration Syntax
public SolverUnitsControlType SolverUnits { set;get; }

StoreBasisResults
Gets or sets the StoreBasisResults.

Declaration Syntax
public YesNoProgrammedControlled StoreBasisResults { set;get; }

Suppressed
Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
242 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

Declaration Syntax
public bool Suppressed { set;get; }

TemperatureUnits
Gets the TemperatureUnits.

Declaration Syntax
public string TemperatureUnits { 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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 243
Ansys.ACT.Automation.Mechanical Namespace

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DetectCondensedPartInterface()
Run the DetectCondensedPartInterface action.

Declaration Syntax
public virtual void DetectCondensedPartInterface()

GenerateCondensedParts()
Run the GenerateCondensedParts action.

Declaration Syntax
public virtual void GenerateCondensedParts()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
244 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartExpansionState

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 120: Members

Constructor CondensedPartExpansionState() (p. 245) Expansion State object.


Property Displacement (p. 245) Gets or sets the Displacement
Property
Property Stress (p. 245) Gets or sets the Stress Property

CondensedPartExpansionState()
Expansion State object.

Declaration Syntax
public CondensedPartExpansionState()

Displacement
Gets or sets the Displacement Property

Declaration Syntax
public bool Displacement { set;get; }

Stress
Gets or sets the Stress Property

Declaration Syntax
public bool Stress { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 245
Ansys.ACT.Automation.Mechanical Namespace

CondensedPartInfoTool
Defines a CondensedPartInfoTool.

Declaration Syntax
public class CondensedPartInfoTool : DataModelObject, IFolderDataModelObject

Table 121: Members

Property Children (p. 246) Gets the list of children.


Property Comments (p. 246) Gets the list of associated comments.
Property DataModelObjectCategory (p. 246) Gets the current DataModelObject's category.
Property Images (p. 247) Gets the list of associated images.
Property InternalObject (p. 247) Gets the internal object. For advanced usage only.
Property Text (p. 247) Gets the Text.
Property UpdateInterval (p. 247) Gets or sets the UpdateInterval.
Method AddComment() (p. 247) Creates a new child Comment.
Method AddImage(string) (p. 247) Creates a new child Image. If a 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. 248) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 248)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 248)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
246 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartInfoTool

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 247
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
248 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionGeometry

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ConstructionGeometry
Defines a ConstructionGeometry.

Declaration Syntax
public class ConstructionGeometry : DataModelObject, IFolderDataModelObject

Table 122: Members

Property Children (p. 249) Gets the list of children.


Property Comments (p. 250) Gets the list of associated comments.
Property DataModelObjectCategory (p. 250) Gets the current DataModelObject's category.
Property Figures (p. 250) Gets the list of associated figures.
Property Images (p. 250) Gets the list of associated images.
Property InternalObject (p. 250) Gets the internal object. For advanced usage only.
Property ShowMesh (p. 250) Gets or sets the ShowMesh.
Method AddComment() (p. 251) Creates a new child Comment.
Method AddFigure() (p. 251) Creates a new child Figure.
Method AddImage(string) (p. 251) Creates a new child Image. If a 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. 251) Creates a new Path
Method AddSolid() (p. 251) Creates a new Solid
Method AddSTL() (p. 251) Creates a new STL
Method AddSurface() (p. 252) Creates a new Surface
Method Delete() (p. 252) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 252)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 252)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 249
Ansys.ACT.Automation.Mechanical Namespace

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
250 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionGeometry

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.

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 251
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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)

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
252 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDebonding

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 123: Members

Property ContactRegion (p. 253) Gets or sets the ContactRegion.


Property CriticalRate (p. 253) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 254) Gets the current DataModelObject's
category.
Property FailureCriteriaOption (p. 254) Gets or sets the FailureCriteriaOption.
Property GenerationMethod (p. 254) Gets or sets the GenerationMethod.
Property InitialCrack (p. 254) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 254) Gets or sets the InitialTimeStep.
Property InternalObject (p. 254) Gets the internal object. For advanced usage
only.
Property Material (p. 255) Gets or sets the Material.
Property MaximumTimeStep (p. 255) Gets or sets the MaximumTimeStep.
Property Method (p. 255) Gets or sets the Method.
Property MinimumTimeStep (p. 255) Gets or sets the MinimumTimeStep.
Property Suppressed (p. 255) Gets or sets the Suppressed.
Property Type (p. 255) Gets the Type.
Method Delete() (p. 256) Run the Delete action.

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

CriticalRate
Gets or sets the CriticalRate.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
Ansys.ACT.Automation.Mechanical Namespace

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; }

GenerationMethod
Gets or sets the GenerationMethod.

Declaration Syntax
public DelaminationGenerationMethod GenerationMethod { set;get; }

InitialCrack
Gets or sets the InitialCrack.

Declaration Syntax
public GenericCrack InitialCrack { set;get; }

InitialTimeStep
Gets or sets the InitialTimeStep.

Declaration Syntax
public Quantity InitialTimeStep { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
254 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDebonding

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaximumTimeStep
Gets or sets the MaximumTimeStep.

Declaration Syntax
public Quantity MaximumTimeStep { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public DelaminationMethod Method { set;get; }

MinimumTimeStep
Gets or sets the MinimumTimeStep.

Declaration Syntax
public Quantity MinimumTimeStep { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Type
Gets the Type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DelaminationType Type { get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ContactMatch
Defines a ContactMatch.

Declaration Syntax
public class ContactMatch : MeshConnectionBase

Table 124: Members

Property Children (p. 461) Gets the list of children.

(Inherited from
MeshConnectionBase (p. 460).)
Property Comments (p. 461) Gets the list of associated comments.

(Inherited from
MeshConnectionBase (p. 460).)
Property DataModelObjectCategory (p. 257)Gets the current DataModelObject's
category.
Property Figures (p. 461) Gets the list of associated figures.

(Inherited from
MeshConnectionBase (p. 460).)
Property Images (p. 462) Gets the list of associated images.

(Inherited from
MeshConnectionBase (p. 460).)
Property InternalObject (p. 258) Gets the internal object. For advanced usage
only.
Property MasterBodies (p. 462) Gets the MasterBodies.

(Inherited from
MeshConnectionBase (p. 460).)
Property MasterLocation (p. 462) Gets or sets the MasterLocation.

(Inherited from
MeshConnectionBase (p. 460).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactMatch

Property ScopeMode (p. 462) Gets the ScopeMode.

(Inherited from
MeshConnectionBase (p. 460).)
Property ScopingMethod (p. 462) No details are provided for this entry.

(Inherited from
MeshConnectionBase (p. 460).)
Property SlaveBodies (p. 463) Gets the SlaveBodies.

(Inherited from
MeshConnectionBase (p. 460).)
Property SlaveLocation (p. 463) Gets or sets the SlaveLocation.

(Inherited from
MeshConnectionBase (p. 460).)
Property SnapToBoundary (p. 463) Gets or sets the SnapToBoundary.

(Inherited from
MeshConnectionBase (p. 460).)
Property SnapTolerance (p. 463) Gets or sets the SnapTolerance.

(Inherited from
MeshConnectionBase (p. 460).)
Property SnapType (p. 463) Gets or sets the SnapType.

(Inherited from
MeshConnectionBase (p. 460).)
Property Suppressed (p. 463) Gets or sets the Suppressed.

(Inherited from
MeshConnectionBase (p. 460).)
Property ToleranceSlider (p. 464) Gets or sets the ToleranceSlider.

(Inherited from
MeshConnectionBase (p. 460).)
Property ToleranceType (p. 464) Gets or sets the ToleranceType.

(Inherited from
MeshConnectionBase (p. 460).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshConnectionAuto InternalObject { get; }

ContactMatchGroup
Defines a ContactMatchGroup.

Declaration Syntax
public class ContactMatchGroup : ConnectionGroup

Table 125: Members

Property ActiveConnections (p. 2484) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 2483).)


Property AutomaticFixedJoints (p. 2484) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 2483).)


Property Children (p. 2484) Gets the list of children.

(Inherited from ConnectionGroup (p. 2483).)


Property Comments (p. 2485) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 2483).)


Property Connections (p. 2485) Gets the Connections.

(Inherited from ConnectionGroup (p. 2483).)


Property ConnectionType (p. 2485) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 2483).)


Property CylindricalFaces (p. 2485) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 2483).)


Property DataModelObjectCategory (p. 260) Gets the current DataModelObject's category.
Property EdgeEdge (p. 2485) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 2483).)


Property EdgeOverlapTolerance (p. 2486) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceAngleTolerance (p. 2486) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 2483).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactMatchGroup

Property FaceEdge (p. 2486) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceFace (p. 2486) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceFaceDetectionAngleTolerence (p. 2486)Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceOverlapTolerance (p. 2486) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property Figures (p. 2487) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 2483).)


Property GroupBy (p. 2487) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 2483).)


Property Images (p. 2487) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 2483).)


Property InternalObject (p. 260) Gets the internal object. For advanced usage
only.
Property Location (p. 2487) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 2483).)


Property MinimumDistancePercentage (p. 2487) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 2483).)


Property MinimumDistanceValue (p. 2488) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 2483).)


Property Priority (p. 2488) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 2483).)


Property RevoluteJoints (p. 2488) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 2483).)


Property SearchAcross (p. 2488) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 2483).)


Property Suppressed (p. 2488) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 2483).)


Property ThicknessScaleFactor (p. 2488) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceSlider (p. 2489) Gets or sets the ToleranceSlider.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceType (p. 2489) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceValue (p. 2489) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 2483).)


Property UseRange (p. 2489) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 2483).)

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.

Declaration Syntax
public class ContactSolutionInformation : DataModelObject, IFolderDataModelObject

Table 126: Members

Property Children (p. 261) Gets the list of children.


Property Comments (p. 261) Gets the list of associated comments.
Property DataModelObjectCategory (p. 261) Gets the current DataModelObject's category.
Property Images (p. 261) Gets the list of associated images.
Property InternalObject (p. 261) Gets the internal object. For advanced usage only.
Property UpdateInterval (p. 262) Gets or sets the UpdateInterval.
Method AddComment() (p. 262) Creates a new child Comment.
Method AddImage(string) (p. 262) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactSolutionInformation

image will be a screen capture of the Geometry


window.
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<DataModelObject>) (p. 263)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 IDSContactInfoToolAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
Ansys.ACT.Automation.Mechanical Namespace

UpdateInterval
Gets or sets the UpdateInterval.

Declaration Syntax
public double UpdateInterval { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

CoordinateSystem
Defines a CoordinateSystem.

Declaration Syntax
public class CoordinateSystem : DataModelObject, ICoordinateSystem, ICoordinateSystemSelection,
IFolderDataModelObject

Table 127: Members

Property APDLName (p. 265) Gets or sets the APDLName.


Property Children (p. 265) Gets the list of children.
Property Comments (p. 265) Gets the list of associated comments.
Property CoordinateSystemID (p. 265) Gets or sets the CoordinateSystemID.
Property CoordinateSystemIDGeneration (p. 265) Gets or sets the CoordinateSystemIDGeneration.
Property CoordinateSystemType (p. 265) Gets or sets the CoordinateSystemType.
Property DataModelObjectCategory (p. 266) Gets the current DataModelObject's category.
Property Figures (p. 266) Gets the list of associated figures.
Property GloballyAvailable (p. 266) Gets or sets the GloballyAvailable.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 263
Ansys.ACT.Automation.Mechanical Namespace

Property Images (p. 266) Gets the list of associated images.


Property InternalObject (p. 266) Gets the internal object. For advanced usage only.
Property IsGlobal (p. 266) Gets the IsGlobal.
Property OriginLocation (p. 267) Gets or sets the origin location.
Property OriginX (p. 267) Gets or sets the origin X coordinate.
Property OriginY (p. 267) Gets or sets the origin Y coordinate.
Property OriginZ (p. 267) Gets or sets the origin Z coordinate.
Property PrimaryAxis (p. 267) Gets or sets the PrimaryAxis.
Property PrimaryAxisDefineBy (p. 267) Gets or sets the PrimaryAxisDefineBy.
Property PrimaryAxisLocation (p. 268) Gets or sets the principal axis geometry selection.
Property ReadOnly (p. 268) Gets the ReadOnly.
Property SecondaryAxis (p. 268) Gets or sets the SecondaryAxis.
Property SecondaryAxisDefineBy (p. 268) Gets or sets the SecondaryAxisDefineBy.
Property SecondaryAxisLocation (p. 268) Gets or sets the orientation about principal axis
geometry selection.
Property Suppressed (p. 268) Gets or sets the Suppressed.
Property TransformationCount (p. 269) Gets the number of transformations.
Property TransformedConfiguration (p. 269) Gets the TransformedConfiguration.
Property XAxisData (p. 269) Gets the XAxisData.
Property YAxisData (p. 269) Gets the YAxisData.
Property ZAxisData (p. 269) Gets the ZAxisData.
Method AddComment() (p. 269) Creates a new child Comment.
Method AddFigure() (p. 270) Creates a new child Figure.
Method AddImage(string) (p. 270) Creates a new child Image. If a 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. 270)
Method CreateConstructionSurface() (p. 270) Run the CreateConstructionSurface action.
Method CreateSectionPlane() (p. 271) Run the CreateSectionPlane action.
Method Delete() (p. 271) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 271)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 271)
Method GetTransformationValue(uint) (p. 272) Gets the value of a transformation.
Method MoveTransformationDown(uint) (p. 272) Moves a transformation down.
Method MoveTransformationUp(uint) (p. 272) Moves a transformation up.
Method RemoveTransformation(uint) (p. 272) Removes a tranformation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Method SetOriginLocation(Quantity, Quantity, Changes the origin location.


Quantity) (p. 273)
Method SetTransformationValue(uint, Sets the value of a transformation.
object) (p. 273)

APDLName
Gets or sets the APDLName.

Declaration Syntax
public string APDLName { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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.

Declaration Syntax
public AutomaticOrManual CoordinateSystemIDGeneration { set;get; }

CoordinateSystemType
Gets or sets the CoordinateSystemType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 265
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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.

Declaration Syntax
public IDSCoordinateSystemAuto InternalObject { get; }

IsGlobal
Gets the IsGlobal.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Declaration Syntax
public bool IsGlobal { 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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 267
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CoordinateSystemAlignmentType PrimaryAxisDefineBy { set;get; }

PrimaryAxisLocation
Gets or sets the principal axis geometry selection.

Declaration Syntax
public ISelectionInfo PrimaryAxisLocation { set;get; }

ReadOnly
Gets the ReadOnly.

Declaration Syntax
public bool ReadOnly { get; }

SecondaryAxis
Gets or sets the SecondaryAxis.

Declaration Syntax
public CoordinateSystemAxisType SecondaryAxis { set;get; }

SecondaryAxisDefineBy
Gets or sets the SecondaryAxisDefineBy.

Declaration Syntax
public CoordinateSystemAlignmentType SecondaryAxisDefineBy { set;get; }

SecondaryAxisLocation
Gets or sets the orientation about principal axis geometry selection.

Declaration Syntax
public ISelectionInfo SecondaryAxisLocation { set;get; }

Suppressed
Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 269
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual 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.

AddTransformation(TransformationType, CoordinateSystemAxisType)
Adds a new transformation.

Declaration Syntax
public virtual void AddTransformation(TransformationType trans, CoordinateSystemAxisType axis)

Parameters
trans(TransformationType)
No details are provided for this entry.

axis(CoordinateSystemAxisType)
No details are provided for this entry.

CreateConstructionSurface()
Run the CreateConstructionSurface action.

Declaration Syntax
public virtual void CreateConstructionSurface()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

CreateSectionPlane()
Run the CreateSectionPlane action.

Declaration Syntax
public virtual void CreateSectionPlane()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
Ansys.ACT.Automation.Mechanical Namespace

children(IList<DataModelObject>)
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).

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).

RemoveTransformation(uint)
Removes a tranformation.

Declaration Syntax
public virtual void RemoveTransformation(uint index)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystems

Parameters
index(uint)
No details are provided for this entry.

SetOriginLocation(Quantity, Quantity, Quantity)


Changes the origin location.

Declaration Syntax
public virtual void SetOriginLocation(Quantity originX, Quantity originY, Quantity originZ)

Parameters
originX(Quantity)
No details are provided for this entry.

originY(Quantity)
No details are provided for this entry.

originZ(Quantity)
No details are provided for this entry.

SetTransformationValue(uint, object)
Sets the value of a transformation.

Declaration Syntax
public virtual void SetTransformationValue(uint index, object value)

Parameters
index(uint)
Index of the transformation (First transformation is 1).

value(object)
Value of the transformation.

CoordinateSystems
Defines a CoordinateSystems.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CoordinateSystems : DataModelObject, IFolderDataModelObject

Table 128: Members

Property Children (p. 274) Gets the list of children.


Property Comments (p. 274) Gets the list of associated comments.
Property DataModelObjectCategory (p. 274) Gets the current DataModelObject's category.
Property Figures (p. 275) Gets the list of associated figures.
Property Images (p. 275) Gets the list of associated images.
Property InternalObject (p. 275) Gets the internal object. For advanced usage only.
Method AddComment() (p. 275) Creates a new child Comment.
Method AddCoordinateSystem() (p. 275) Creates a new CoordinateSystem
Method AddFigure() (p. 275) Creates a new child Figure.
Method AddImage(string) (p. 276) Creates a new child Image. If a 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. 276)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 276)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystems

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

Declaration Syntax
public virtual CoordinateSystem AddCoordinateSystem()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 275
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.
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. 278) Gets or sets the AlignWithFaceNormal.


Property BottomFaceNodes (p. 278) Gets or sets the BottomFaceNodes.
Property Children (p. 347) Gets the list of children.

(Inherited from GenericCrack (p. 347).)


Property CircumferentialDivisions (p. 278) Gets or sets the CircumferentialDivisions.
Property Comments (p. 348) Gets the list of associated comments.

(Inherited from GenericCrack (p. 347).)


Property Contact1Nodes (p. 278) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 278) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 279) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 279) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 279) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 279) Gets or sets the CrackFrontNodes.
Property CrackShape (p. 279) Gets the CrackShape.
Property CrackSourceType (p. 279) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 348) Gets the current DataModelObject's
category.

(Inherited from GenericCrack (p. 347).)


Property FaceTopNodes (p. 280) Gets or sets the FaceTopNodes.
Property Figures (p. 348) Gets the list of associated figures.

(Inherited from GenericCrack (p. 347).)


Property FractureAffectedZone (p. 280) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 280) Gets or sets the FractureAffectedZoneHeight.
Property Images (p. 348) Gets the list of associated images.

(Inherited from GenericCrack (p. 347).)


Property InternalObject (p. 280) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 280) Gets or sets the LargestContourRadius.
Property Location (p. 280) Gets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
Ansys.ACT.Automation.Mechanical Namespace

Property MajorRadius (p. 281) Gets or sets the MajorRadius.


Property MeshContours (p. 281) Gets or sets the MeshContours.
Property MinorRadius (p. 281) Gets or sets the MinorRadius.
Property ProjectToNearestSurface (p. 281) Gets or sets the ProjectToNearestSurface.
Property SolutionContours (p. 281) Gets or sets the SolutionContours.
Property Suppressed (p. 281) Gets or sets the Suppressed.
Property Target1Nodes (p. 282) Gets or sets the Target1Nodes.
Property XScaleFactor (p. 282) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 282) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 282) Gets or sets the ZScaleFactor.

AlignWithFaceNormal
Gets or sets the AlignWithFaceNormal.

Declaration Syntax
public bool AlignWithFaceNormal { set;get; }

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.
Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

FaceTopNodes
Gets or sets the FaceTopNodes.

Declaration Syntax
public string FaceTopNodes { set;get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public Quantity FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.
Declaration Syntax
public ISelectionInfo Location { get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

Criterion
Defines a Criterion.

Declaration Syntax
public class Criterion : DataModelObject, IFolderDataModelObject

Table 130: Members

Property Children (p. 283) Gets the list of children.


Property Comments (p. 283) Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
Criterion

Property DataModelObjectCategory (p. 283) Gets the current DataModelObject's category.


Property Figures (p. 283) Gets the list of associated figures.
Property Images (p. 284) Gets the list of associated images.
Property InternalObject (p. 284) Gets the internal object. For advanced usage only.
Property Suppressed (p. 284) Gets or sets the Suppressed.
Property Value (p. 284) Gets the Value.
Method AddComment() (p. 284) Creates a new child Comment.
Method AddFigure() (p. 284) Creates a new child Figure.
Method AddImage(string) (p. 285) Creates a new child Image. If a 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. 285) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 285)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 285)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoCriterionAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Value
Gets the Value.

Declaration Syntax
public int Value { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
Criterion

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

CriterionConstraint
Defines a CriterionConstraint.

Declaration Syntax
public class CriterionConstraint : ResponseConstraint

Table 131: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property Criterion (p. 286) Gets or sets the Criterion.
Property DataModelObjectCategory (p. 287)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InitialValue (p. 287) Gets the InitialValue.
Property InternalObject (p. 287) Gets the internal object. For advanced usage only.
Property LowerBound (p. 287) Gets or sets the LowerBound.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)


Property UpperBound (p. 287) Gets or sets the UpperBound.

Criterion
Gets or sets the Criterion.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSection

Declaration Syntax
public Criterion Criterion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InitialValue
Gets the InitialValue.

Declaration Syntax
public double InitialValue { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

LowerBound
Gets or sets the LowerBound.

Declaration Syntax
public double LowerBound { set;get; }

UpperBound
Gets or sets the UpperBound.

Declaration Syntax
public double UpperBound { set;get; }

CrossSection
Defines a CrossSection.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CrossSection : DataModelObject, IFolderDataModelObject

Table 132: Members

Property Children (p. 288) Gets the list of children.


Property Comments (p. 288) Gets the list of associated comments.
Property DataModelObjectCategory (p. 288) Gets the current DataModelObject's category.
Property Figures (p. 289) Gets the list of associated figures.
Property Images (p. 289) Gets the list of associated images.
Property InternalObject (p. 289) Gets the internal object. For advanced usage only.
Method AddComment() (p. 289) Creates a new child Comment.
Method AddFigure() (p. 289) Creates a new child Figure.
Method AddImage(string) (p. 289) Creates a new child Image. If a 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. 290) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 290)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 290)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSection

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSections

CrossSections
Defines a CrossSections.

Declaration Syntax
public class CrossSections : DataModelObject, IFolderDataModelObject

Table 133: Members

Property Children (p. 291) Gets the list of children.


Property Comments (p. 291) Gets the list of associated comments.
Property DataModelObjectCategory (p. 291) Gets the current DataModelObject's category.
Property Figures (p. 292) Gets the list of associated figures.
Property Images (p. 292) Gets the list of associated images.
Property InternalObject (p. 292) Gets the internal object. For advanced usage only.
Method AddComment() (p. 292) Creates a new child Comment.
Method AddFigure() (p. 292) Creates a new child Figure.
Method AddImage(string) (p. 292) Creates a new child Image. If a 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. 293) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 293)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 293)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
Ansys.ACT.Automation.Mechanical Namespace

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; }

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSections

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
Ansys.ACT.Automation.Mechanical Namespace

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

CyclicManufacturingConstraint
Defines a CyclicManufacturingConstraint.

Declaration Syntax
public class CyclicManufacturingConstraint : ManufacturingConstraint

Table 134: Members

Property Axis (p. 294) Gets or sets the Axis.


Property Children (p. 436) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 435).)
Property CoordinateSystem (p. 294) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 295)Gets the current DataModelObject's
category.
Property InternalObject (p. 295) Gets the internal object. For advanced usage
only.
Property Location (p. 295) Gets or sets the Location.
Property NumberofSectors (p. 295) Gets or sets the NumberofSectors.
Property ScopingMethod (p. 295) Gets or sets the ScopingMethod.
Property Selection (p. 436) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 435).)
Property Suppressed (p. 437) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 435).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
CyclicRegion

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; }

NumberofSectors
Gets or sets the NumberofSectors.

Declaration Syntax
public uint NumberofSectors { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

CyclicRegion
Defines a CyclicRegion.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 295
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CyclicRegion : SymmetryGeneral

Table 135: Members

Property Children (p. 783) Gets the list of children.

(Inherited from SymmetryGeneral (p. 782).)


Property Comments (p. 783) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 782).)


Property CoordinateSystem (p. 784) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 782).)


Property DataModelObjectCategory (p. 296)Gets the current DataModelObject's
category.
Property Figures (p. 784) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 782).)


Property HighBoundaryLocation (p. 784) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property Images (p. 784) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 782).)


Property InternalObject (p. 297) Gets the internal object. For advanced usage
only.
Property Location (p. 785) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 782).)


Property LowBoundaryLocation (p. 785) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property ScopeMode (p. 785) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 782).)


Property Suppressed (p. 785) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 782).)


Method FlipHighLow() (p. 297) Flips the High and Low Boundaries.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplacementConstraint

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

FlipHighLow()
Flips the High and Low Boundaries.

Declaration Syntax
public virtual void FlipHighLow()

DisplacementConstraint
Defines a DisplacementConstraint.

Declaration Syntax
public class DisplacementConstraint : ResponseConstraint

Table 136: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 297)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 298) Gets the internal object. For advanced usage only.
Property Location (p. 298) Gets or sets the Location.
Property ScopingMethod (p. 298) Gets or sets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)


Property XComponentMax (p. 298) Gets or sets the XComponentMax.
Property YComponentMax (p. 298) Gets or sets the YComponentMax.
Property ZComponentMax (p. 298) Gets or sets the ZComponentMax.

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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; }

XComponentMax
Gets or sets the XComponentMax.

Declaration Syntax
public Field XComponentMax { get; }

YComponentMax
Gets or sets the YComponentMax.

Declaration Syntax
public Field YComponentMax { get; }

ZComponentMax
Gets or sets the ZComponentMax.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
DistributedMass

Declaration Syntax
public Field ZComponentMax { get; }

DistributedMass
Defines a DistributedMass.

Declaration Syntax
public class DistributedMass : GenericPointMass

Table 137: Members

Property Children (p. 354) Gets the list of children.

(Inherited from GenericPointMass (p. 353).)


Property Comments (p. 354) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 353).)


Property DataModelObjectCategory (p. 299)Gets the current DataModelObject's category.
Property Figures (p. 355) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 353).)


Property Images (p. 355) Gets the list of associated images.

(Inherited from GenericPointMass (p. 353).)


Property InternalObject (p. 300) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 355) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 353).)


Property Location (p. 355) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 353).)


Property MassPerUnitArea (p. 300) Gets or sets the MassPerUnitArea.
Property MassType (p. 300) Gets or sets the MassType.
Property RemotePoint (p. 355) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 353).)


Property Suppressed (p. 300) Gets or sets the Suppressed.
Property TotalMass (p. 300) Gets or sets the TotalMass.

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

ElementOrientation
Defines a ElementOrientation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementOrientation

Declaration Syntax
public class ElementOrientation : DataModelObject, IFolderDataModelObject

Table 138: Members

Property AxisEdgeOrientation (p. 301) Gets or sets the AxisEdgeOrientation.


Property AxisSurfaceOrientation (p. 301) Gets or sets the AxisSurfaceOrientation.
Property BodyLocation (p. 302) Gets or sets the BodyLocation.
Property Children (p. 302) Gets the list of children.
Property Comments (p. 302) Gets the list of associated comments.
Property CoordinateSystem (p. 302) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 302) Gets the current DataModelObject's category.
Property EdgeLocation (p. 302) Gets or sets the EdgeLocation.
Property Figures (p. 303) Gets the list of associated figures.
Property Images (p. 303) Gets the list of associated images.
Property InternalObject (p. 303) Gets the internal object. For advanced usage only.
Property OrientationGuideDefinedBy (p. 303) Gets or sets the OrientationGuideDefinedBy.
Property Suppressed (p. 303) Gets or sets the Suppressed.
Property SurfaceLocation (p. 303) Gets or sets the SurfaceLocation.
Method AddComment() (p. 304) Creates a new child Comment.
Method AddFigure() (p. 304) Creates a new child Figure.
Method AddImage(string) (p. 304) Creates a new child Image. If a 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. 304) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 304)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 305)

AxisEdgeOrientation
Gets or sets the AxisEdgeOrientation.

Declaration Syntax
public ElementOrientationAxisType AxisEdgeOrientation { set;get; }

AxisSurfaceOrientation
Gets or sets the AxisSurfaceOrientation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EdgeLocation
Gets or sets the EdgeLocation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementOrientation

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; }

SurfaceLocation
Gets or sets the SurfaceLocation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
Ansys.ACT.Automation.Mechanical Namespace

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()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
EndRelease

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

EndRelease
Defines a EndRelease.

Declaration Syntax
public class EndRelease : DataModelObject, IFolderDataModelObject

Table 139: Members

Property Behavior (p. 306) Gets or sets the Behavior.


Property Children (p. 306) Gets the list of children.
Property Comments (p. 306) Gets the list of associated comments.
Property CoordinateSystem (p. 307) Gets or sets the Coordinate System.
Property DataModelObjectCategory (p. 307) Gets the current DataModelObject's category.
Property EdgeLocation (p. 307) Gets or sets the EdgeLocation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
Ansys.ACT.Automation.Mechanical Namespace

Property Figures (p. 307) Gets the list of associated figures.


Property Images (p. 307) Gets the list of associated images.
Property IndependentEdges (p. 307) Gets or sets the IndependentEdges.
Property InternalObject (p. 308) Gets the internal object. For advanced usage only.
Property RotationX (p. 308) Gets or sets the RotationX.
Property RotationY (p. 308) Gets or sets the RotationY.
Property RotationZ (p. 308) Gets or sets the RotationZ.
Property Suppressed (p. 308) Gets or sets the Suppressed.
Property TranslationX (p. 308) Gets or sets the TranslationX.
Property TranslationY (p. 309) Gets or sets the TranslationY.
Property TranslationZ (p. 309) Gets or sets the TranslationZ.
Property VertexLocation (p. 309) Gets or sets the VertexLocation.
Method AddComment() (p. 309) Creates a new child Comment.
Method AddFigure() (p. 309) Creates a new child Figure.
Method AddImage(string) (p. 309) Creates a new child Image. If a 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. 310) Run the Delete action.
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<DataModelObject>) (p. 310)

Behavior
Gets or sets the Behavior.

Declaration Syntax
public BeamEndReleaseBehavior Behavior { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
EndRelease

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the Coordinate System.

Declaration Syntax
public ICoordinateSystemSelection CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EdgeLocation
Gets or sets the EdgeLocation.

Declaration Syntax
public ISelectionInfo EdgeLocation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

IndependentEdges
Gets or sets the IndependentEdges.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool IndependentEdges { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSBeamEndReleaseAuto InternalObject { get; }

RotationX
Gets or sets the RotationX.

Declaration Syntax
public FixedOrFree RotationX { set;get; }

RotationY
Gets or sets the RotationY.

Declaration Syntax
public FixedOrFree RotationY { set;get; }

RotationZ
Gets or sets the RotationZ.

Declaration Syntax
public FixedOrFree RotationZ { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TranslationX
Gets or sets the TranslationX.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
EndRelease

Declaration Syntax
public FixedOrFree TranslationX { set;get; }

TranslationY
Gets or sets the TranslationY.

Declaration Syntax
public FixedOrFree TranslationY { set;get; }

TranslationZ
Gets or sets the TranslationZ.

Declaration Syntax
public FixedOrFree TranslationZ { set;get; }

VertexLocation
Gets or sets the VertexLocation.

Declaration Syntax
public ISelectionInfo VertexLocation { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
ExclusionRegion

children(IList<DataModelObject>)
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 140: Members

Property Children (p. 553) Gets the list of children.

(Inherited from
OptimizationRegionBaseClass (p. 552).)
Property DataModelObjectCategory (p. 311) Gets the current DataModelObject's category.
Property ExclusionRegionLocation (p. 311) Gets or sets the ExclusionRegionLocation.
Property InternalObject (p. 311) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 312) Gets or sets the Suppressed.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ExclusionRegionLocation
Gets or sets the ExclusionRegionLocation.

Declaration Syntax
public ISelectionInfo ExclusionRegionLocation { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSOptimizationRegionAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 311
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ExpansionSettings
Defines a ExpansionSettings.

Declaration Syntax
public class ExpansionSettings : DataModelObject, IFolderDataModelObject

Table 141: Members

Property Children (p. 313) Gets the list of children.


Property CleanupOptionalFiles (p. 313) Gets or sets the
CleanupOptionalFiles.
Property Comments (p. 313) Gets the list of associated comments.
Property CondensedPartExpansionType (p. 313) Gets or sets the
CondensedPartExpansionType.
Property DataModelObjectCategory (p. 314) Gets the current DataModelObject's
category.
Property ExpandAfterUsePassFailure (p. 314) Gets or sets the
ExpandAfterUsePassFailure.
Property Figures (p. 314) Gets the list of associated figures.
Property GeneralMiscellaneous (p. 314) Gets or sets the
GeneralMiscellaneous.
Property Images (p. 314) Gets the list of associated images.
Property InternalObject (p. 314) Gets the internal object. For
advanced usage only.
Property NodalForces (p. 315) Gets or sets the NodalForces.
Property Strain (p. 315) Gets or sets the Strain.
Property Stress (p. 315) Gets or sets the Stress.
Method AddComment() (p. 315) Creates a new child Comment.
Method AddFigure() (p. 315) Creates a new child Figure.
Method AddImage(string) (p. 315) Creates a new child Image. If a
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. 316) Run the ClearGeneratedData action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
312 of ANSYS, Inc. and its subsidiaries and affiliates.
ExpansionSettings

Method CreateResultsAtAllSets() (p. 316) Run the CreateResultsAtAllSets


action.
Method Delete() (p. 316) Run the Delete action.
Method EvaluateAllResults() (p. 316) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 316) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<DataModelObject>) (p. 317) type.
Method GetCompletedExpansionState(CondensedPart) (p. 317) Gets the completed expansion state
of a given Condensed Part
Method GetExpansionState(CondensedPart) (p. 317) Gets the requested expansion state
of a given Condensed Part
Method PerformExpansionPass() (p. 318) Run the PerformExpansionPass
action.
Method SetExpansionState(CondensedPart, Sets the requested expansion state
CondensedPartExpansionState) (p. 318) of a given Condensed Part

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
Ansys.ACT.Automation.Mechanical Namespace

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
ExpansionSettings

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; }

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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()
Run the CreateResultsAtAllSets action.

Declaration Syntax
public virtual void CreateResultsAtAllSets()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
ExpansionSettings

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetCompletedExpansionState(CondensedPart)
Gets the completed expansion state of a given Condensed Part

Declaration Syntax
public virtual CondensedPartExpansionState GetCompletedExpansionState(CondensedPart condensed-
Part)

Parameters
condensedPart(CondensedPart)
No details are provided for this entry.

GetExpansionState(CondensedPart)
Gets the requested expansion state of a given Condensed Part

Declaration Syntax
public virtual CondensedPartExpansionState GetExpansionState(CondensedPart condensedPart)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
Ansys.ACT.Automation.Mechanical Namespace

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.

ExternalEnhancedModel
Defines a ExternalEnhancedModel.

Declaration Syntax
public class ExternalEnhancedModel : DataModelObject, IFolderDataModelObject

Table 142: Members

Property Children (p. 319) Gets the list of children.


Property Comments (p. 319) Gets the list of associated comments.
Property DataModelObjectCategory (p. 319) Gets the current DataModelObject's category.
Property Figures (p. 319) Gets the list of associated figures.
Property Images (p. 320) Gets the list of associated images.
Property InternalObject (p. 320) Gets the internal object. For advanced usage only.
Property LayerToDisplay (p. 320) Gets or sets the LayerToDisplay.
Property MaximumNumberOfLayers (p. 320) Gets the MaximumNumberOfLayers.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalEnhancedModel

Property NonlinearEffects (p. 320) Gets or sets the NonlinearEffects.


Property Suppressed (p. 320) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 321) Gets or sets the ThermalStrainEffects.
Property Type (p. 321) Gets the Type.
Method AddComment() (p. 321) Creates a new child Comment.
Method AddFigure() (p. 321) Creates a new child Figure.
Method AddImage(string) (p. 321) Creates a new child Image. If a 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. 321)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 322)
Method RegroupToDefault() (p. 322) Run the RegroupToDefault action.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalEnhancedModel

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 321
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalModelDataColl

Declaration Syntax
public class ExternalModelDataColl : DataModelObject, IReadOnlyList<ImportedObject>, IReadOnlyCol-
lection<ImportedObject>, IEnumerable<ImportedObject>, IEnumerable, IFolderDataModelObject

Table 143: Members

Property Children (p. 323) Gets the list of children.


Property Comments (p. 323) Gets the list of associated comments.
Property Count (p. 323) Gets the NumberOfRows.
Property DataModelObjectCategory (p. 324) Gets the current DataModelObject's category.
Property Figures (p. 324) Gets the list of associated figures.
Property Images (p. 324) Gets the list of associated images.
Property InternalObject (p. 324) Gets the internal object. For advanced usage only.
Property Suppressed (p. 324) Gets or sets the Suppressed.
Method AddComment() (p. 324) Creates a new child Comment.
Method AddFigure() (p. 325) Creates a new child Figure.
Method AddImage(string) (p. 325) Creates a new child Image. If a 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. 325)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 325)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Count
Gets the NumberOfRows.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 323
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalModelDataColl

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.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 144: Members

Property Axis (p. 326) Gets or sets the Axis.


Property Children (p. 436) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 435).)
Property CoordinateSystem (p. 327) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 327)Gets the current DataModelObject's
category.
Property InternalObject (p. 327) Gets the internal object. For advanced usage
only.
Property ScopingMethod (p. 327) Gets the ScopingMethod.
Property Selection (p. 436) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 435).)
Property Suppressed (p. 437) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 435).)

Axis
Gets or sets the Axis.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

ScopingMethod
Gets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

FatigueTool
Defines a FatigueTool.

Declaration Syntax
public class FatigueTool : DataModelObject, IFolderDataModelObject

Table 145: Members

Property AnalysisType (p. 329) Gets or sets the AnalysisType.


Property BinSize (p. 329) Gets or sets the BinSize.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
Ansys.ACT.Automation.Mechanical Namespace

Property Children (p. 329) Gets the list of children.


Property Comments (p. 329) Gets the list of associated comments.
Property DataModelObjectCategory (p. 329) Gets the current DataModelObject's category.
Property DisplayTime (p. 329) Gets or sets the DisplayTime.
Property ExposureDuration (p. 330) Gets or sets the ExposureDuration.
Property FatigueStrengthFactor (p. 330) Gets or sets the FatigueStrengthFactor.
Property Frequency (p. 330) Gets or sets the Frequency.
Property FrequencySelection (p. 330) Gets or sets the FrequencySelection.
Property HistoryDataLocation (p. 330) Gets or sets the HistoryDataLocation.
Property Images (p. 330) Gets the list of associated images.
Property InfiniteLife (p. 331) Gets or sets the InfiniteLife.
Property InternalObject (p. 331) Gets the internal object. For advanced usage only.
Property LoadingRatio (p. 331) Gets or sets the LoadingRatio.
Property LoadingType (p. 331) Gets or sets the LoadingType.
Property MaximumDataPointsToPlot (p. 331) Gets or sets the MaximumDataPointsToPlot.
Property MeanStressTheory (p. 331) Gets or sets the MeanStressTheory.
Property MethodSelection (p. 332) Gets or sets the MethodSelection.
Property OneCycleIsEqualTo (p. 332) Gets or sets the OneCycleIsEqualTo.
Property ResultsInput (p. 332) Gets or sets the ResultsInput.
Property ScaleFactor (p. 332) Gets or sets the ScaleFactor.
Property StressComponent (p. 332) Gets or sets the StressComponent.
Property UnitsName (p. 332) Gets or sets the UnitsName.
Property UseQuickRainflowCounting (p. 333) Gets or sets the UseQuickRainflowCounting.
Method AddBiaxialityIndication() (p. 333) Creates a new FatigueBiaxialityIndication
Method AddComment() (p. 333) Creates a new child Comment.
Method AddDamage() (p. 333) Creates a new FatigueDamage
Method AddDamageMatrix() (p. 333) Creates a new FatigueDamageMatrix
Method AddEquivalentAlternativeStress() (p. 333) Creates a new FatigueEquivalentAlternativeStress
Method AddFatigueSensitivity() (p. 334) Creates a new FatigueSensitivity
Method AddHysteresis() (p. 334) Creates a new FatigueHysteresis
Method AddImage(string) (p. 334) Creates a new child Image. If a 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. 334) Creates a new FatigueLife
Method AddRainflowMatrix() (p. 334) Creates a new FatigueRainflowMatrix
Method AddSafetyFactor() (p. 335) Creates a new FatigueSafetyFactor
Method Delete() (p. 335) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 335)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<DataModelObject>) (p. 335)

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<DataModelObject> 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; }

DisplayTime
Gets or sets the DisplayTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity DisplayTime { set;get; }

ExposureDuration
Gets or sets the ExposureDuration.

Declaration Syntax
public Quantity ExposureDuration { set;get; }

FatigueStrengthFactor
Gets or sets the FatigueStrengthFactor.

Declaration Syntax
public double FatigueStrengthFactor { set;get; }

Frequency
Gets or sets the Frequency.

Declaration Syntax
public Quantity Frequency { set;get; }

FrequencySelection
Gets or sets the FrequencySelection.

Declaration Syntax
public FatigueFrequencySelection FrequencySelection { set;get; }

HistoryDataLocation
Gets or sets the HistoryDataLocation.

Declaration Syntax
public string HistoryDataLocation { set;get; }

Images
Gets the list of associated images.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

Declaration Syntax
public IEnumerable<Image> Images { get; }

InfiniteLife
Gets or sets the InfiniteLife.

Declaration Syntax
public double InfiniteLife { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFatigueToolAuto InternalObject { get; }

LoadingRatio
Gets or sets the LoadingRatio.

Declaration Syntax
public double LoadingRatio { set;get; }

LoadingType
Gets or sets the LoadingType.

Declaration Syntax
public FatigueLoadType LoadingType { set;get; }

MaximumDataPointsToPlot
Gets or sets the MaximumDataPointsToPlot.

Declaration Syntax
public double MaximumDataPointsToPlot { set;get; }

MeanStressTheory
Gets or sets the MeanStressTheory.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public MeanStressTheoryType MeanStressTheory { set;get; }

MethodSelection
Gets or sets the MethodSelection.

Declaration Syntax
public FatigueToolMethod MethodSelection { set;get; }

OneCycleIsEqualTo
Gets or sets the OneCycleIsEqualTo.

Declaration Syntax
public Quantity OneCycleIsEqualTo { set;get; }

ResultsInput
Gets or sets the ResultsInput.

Declaration Syntax
public FatigueToolResultsInputType ResultsInput { set;get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public double ScaleFactor { set;get; }

StressComponent
Gets or sets the StressComponent.

Declaration Syntax
public FatigueStressComponentType StressComponent { set;get; }

UnitsName
Gets or sets the UnitsName.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

Declaration Syntax
public LifeUnitsType UnitsName { set;get; }

UseQuickRainflowCounting
Gets or sets the UseQuickRainflowCounting.

Declaration Syntax
public bool UseQuickRainflowCounting { set;get; }

AddBiaxialityIndication()
Creates a new FatigueBiaxialityIndication

Declaration Syntax
public virtual FatigueBiaxialityIndication AddBiaxialityIndication()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddDamage()
Creates a new FatigueDamage

Declaration Syntax
public virtual FatigueDamage AddDamage()

AddDamageMatrix()
Creates a new FatigueDamageMatrix

Declaration Syntax
public virtual FatigueDamageMatrix AddDamageMatrix()

AddEquivalentAlternativeStress()
Creates a new FatigueEquivalentAlternativeStress

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual FatigueEquivalentAlternativeStress AddEquivalentAlternativeStress()

AddFatigueSensitivity()
Creates a new FatigueSensitivity

Declaration Syntax
public virtual FatigueSensitivity AddFatigueSensitivity()

AddHysteresis()
Creates a new FatigueHysteresis

Declaration Syntax
public virtual FatigueHysteresis AddHysteresis()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

AddLife()
Creates a new FatigueLife

Declaration Syntax
public virtual FatigueLife AddLife()

AddRainflowMatrix()
Creates a new FatigueRainflowMatrix

Declaration Syntax
public virtual FatigueRainflowMatrix AddRainflowMatrix()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

AddSafetyFactor()
Creates a new FatigueSafetyFactor

Declaration Syntax
public virtual FatigueSafetyFactor AddSafetyFactor()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
Ansys.ACT.Automation.Mechanical Namespace

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Figure
Defines a Figure.

Declaration Syntax
public class Figure : DataModelObject, IFolderDataModelObject

Table 146: Members

Property Children (p. 336) Gets the list of children.


Property Comments (p. 336) Gets the list of associated comments.
Property DataModelObjectCategory (p. 336) Gets the current DataModelObject's
category.
Property InternalObject (p. 337) Gets the internal object. For advanced
usage only.
Property Text (p. 337) Gets or sets the Text.
Method AddComment() (p. 337) Creates a new child Comment.
Method Delete() (p. 337) Run the Delete action.
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<DataModelObject>) (p. 338)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
Figure

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFigureAuto InternalObject { get; }

Text
Gets or sets the Text.

Declaration Syntax
public string Text { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Delete()
Run the Delete action.

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Fracture
Defines a Fracture.

Declaration Syntax
public class Fracture : DataModelObject, IFolderDataModelObject

Table 147: Members

Property Children (p. 339) Gets the list of children.


Property Comments (p. 339) Gets the list of associated comments.
Property DataModelObjectCategory (p. 339) Gets the current DataModelObject's category.
Property Figures (p. 339) Gets the list of associated figures.
Property Images (p. 340) Gets the list of associated images.
Property InternalObject (p. 340) Gets the internal object. For advanced usage
only.
Method AddArbitraryCrack() (p. 340) Creates a new ArbitraryCrack
Method AddComment() (p. 340) Creates a new child Comment.
Method AddContactDebonding() (p. 340) Creates a new ContactDebonding
Method AddCrack() ***OBSOLETE*** Use the method Creates a new child Crack.
AddArbitraryCrack or AddSemiEllipticalCrack
instead. (p. 340)
Method AddFigure() (p. 341) Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
Fracture

Method AddImage(string) (p. 341) Creates a new child Image. If a 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. 341) Creates a new InterfaceDelamination
Method AddPreMeshedCrack() (p. 341) Creates a new PreMeshedCrack
Method AddSemiEllipticalCrack() (p. 341) Creates a new SemiEllipticalCrack
Method AddSMARTCrackGrowth() (p. 341) Creates a new SMARTCrackGrowth
Method Delete() (p. 342) Run the Delete action.
Method GenerateAllCrackMesh() (p. 342) Run the GenerateAllCrackMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 342)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 342)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
Ansys.ACT.Automation.Mechanical Namespace

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; }

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
340 of ANSYS, Inc. and its subsidiaries and affiliates.
Fracture

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

AddInterfaceDelamination()
Creates a new InterfaceDelamination

Declaration Syntax
public virtual InterfaceDelamination AddInterfaceDelamination()

AddPreMeshedCrack()
Creates a new PreMeshedCrack

Declaration Syntax
public virtual PreMeshedCrack AddPreMeshedCrack()

AddSemiEllipticalCrack()
Creates a new SemiEllipticalCrack

Declaration Syntax
public virtual SemiEllipticalCrack AddSemiEllipticalCrack()

AddSMARTCrackGrowth()
Creates a new SMARTCrackGrowth

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
Ansys.ACT.Automation.Mechanical Namespace

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()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
GeneralAxisymmetric

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject, IFolderDataModelObject

Table 148: Members

Property Axis (p. 343) Gets or sets the Axis.


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 Figures (p. 344) Gets the list of associated figures.
Property Images (p. 344) Gets the list of associated images.
Property InternalObject (p. 345) Gets the internal object. For advanced usage only.
Property Location (p. 345) Gets or sets the Location.
Property NodalPlanes (p. 345) Gets or sets the NodalPlanes.
Property Suppressed (p. 345) Gets or sets the Suppressed.
Method AddComment() (p. 345) Creates a new child Comment.
Method AddFigure() (p. 345) 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 GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 346)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 346)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
Ansys.ACT.Automation.Mechanical Namespace

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
GeneralAxisymmetric

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeneralAxisymmetricAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NodalPlanes
Gets or sets the NodalPlanes.

Declaration Syntax
public uint NodalPlanes { set;get; }

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericCrack

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject, IFolderDataModelObject

Table 149: Members

Property Children (p. 347) Gets the list of children.


Property Comments (p. 348) Gets the list of associated comments.
Property DataModelObjectCategory (p. 348) Gets the current DataModelObject's category.
Property Figures (p. 348) Gets the list of associated figures.
Property Images (p. 348) Gets the list of associated images.
Property InternalObject (p. 348) Gets the internal object. For advanced usage only.
Method AddCommandSnippet() (p. 348) Creates a new CommandSnippet
Method AddComment() (p. 349) Creates a new child Comment.
Method AddFigure() (p. 349) Creates a new child Figure.
Method AddImage(string) (p. 349) Creates a new child Image. If a 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. 349) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 349)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 350)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
Ansys.ACT.Automation.Mechanical Namespace

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 IDSCrackAuto InternalObject { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
348 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericCrack

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject, IFolderDataModelObject

Table 150: Members

Property Children (p. 351) Gets the list of children.


Property Comments (p. 351) Gets the list of associated comments.
Property DataModelObjectCategory (p. 351) Gets the current DataModelObject's category.
Property Figures (p. 351) Gets the list of associated figures.
Property Images (p. 351) Gets the list of associated images.
Property InternalObject (p. 352) Gets the internal object. For advanced usage only.
Method AddCommandSnippet() (p. 352) Creates a new CommandSnippet
Method AddComment() (p. 352) Creates a new child Comment.
Method AddFigure() (p. 352) Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericDelamination

Method AddImage(string) (p. 352) Creates a new child Image. If a 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. 353) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 353)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 353)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 351
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
352 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericPointMass

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GenericPointMass
Defines a GenericPointMass.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 353
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public abstract class GenericPointMass : DataModelObject, IFolderDataModelObject

Table 151: Members

Property Children (p. 354) Gets the list of children.


Property Comments (p. 354) Gets the list of associated comments.
Property DataModelObjectCategory (p. 354) Gets the current DataModelObject's category.
Property Figures (p. 355) Gets the list of associated figures.
Property Images (p. 355) Gets the list of associated images.
Property InternalObject (p. 355) Gets the internal object. For advanced usage only.
Property IsDistributedMass (p. 355) Gets the IsDistributedMass.
Property Location (p. 355) Gets or sets the Geometry.
Property RemotePoint (p. 355) Gets the remote point associated to the point mass.
Method AddComment() (p. 356) Creates a new child Comment.
Method AddFigure() (p. 356) Creates a new child Figure.
Method AddImage(string) (p. 356) Creates a new child Image. If a 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. 356) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 356)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 357)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
354 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericPointMass

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

IsDistributedMass
Gets the IsDistributedMass.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 355
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public RemotePoint RemotePoint { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 152: Members

Property ActiveBodies (p. 360) Gets the ActiveBodies.


Property AnalysisType (p. 360) Gets the AnalysisType.
Property AssignMaterialOnUpdate (p. 360) Gets or sets the AssignMaterialOnUpdate.
Property AttachFileViaTempFile (p. 360) Gets or sets the AttachFileViaTempFile.
Property AttributeKey (p. 360) Gets the AttributeKey.
Property Attributes (p. 360) Gets the Attributes.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 357
Ansys.ACT.Automation.Mechanical Namespace

Property Average (p. 361) Gets the Average.


Property Bodies (p. 361) Gets the Bodies.
Property CanChangeCADUnits (p. 361) Gets the CanChangeCADUnits.
Property Children (p. 361) Gets the list of children.
Property Comments (p. 361) Gets the list of associated comments.
Property ComparePartsOnUpdate (p. 361) Gets the ComparePartsOnUpdate.
Property ComparePartsTolerance (p. 362) Gets the ComparePartsTolerance.
Property DataModelObjectCategory (p. 362) Gets the current DataModelObject's category.
Property DecomposeDisjointGeometry (p. 362) Gets the DecomposeDisjointGeometry.
Property DisplayStyle (p. 362) Gets or sets the DisplayStyle.
Property ElementControl (p. 362) Gets or sets the ElementControl.
Property Elements (p. 362) Gets the Elements.
Property EnclosureAndSymmetryProcessing (p. 363) Gets the EnclosureAndSymmetryProcessing.
Property EndPlaneRotationAboutX (p. 363) Gets or sets the EndPlaneRotationAboutX.
Property EndPlaneRotationAboutY (p. 363) Gets or sets the EndPlaneRotationAboutY.
Property FiberLength (p. 363) Gets or sets the FiberLength.
Property Figures (p. 363) Gets the list of associated figures.
Property GeometryPreferencesReadOnly (p. 363) Gets the GeometryPreferencesReadOnly.
Property Images (p. 364) Gets the list of associated images.
Property ImportCoordinateSystems (p. 364) Gets the ImportCoordinateSystems.
Property InternalObject (p. 364) Gets the internal object. For advanced usage
only.
Property LengthUnit (p. 364) Gets the LengthUnit.
Property LengthX (p. 364) Gets the LengthX.
Property LengthY (p. 364) Gets the LengthY.
Property LengthZ (p. 365) Gets the LengthZ.
Property LineBodies (p. 365) Gets the LineBodies.
Property Mass (p. 365) Gets the Mass.
Property MaterialProperties (p. 365) Gets the MaterialProperties.
Property Maximum (p. 365) Gets the Maximum.
Property MeshMetric (p. 365) Gets the MeshMetric.
Property MeshVolume (p. 366) Gets the MeshVolume.
Property Minimum (p. 366) Gets the Minimum.
Property MixedImportResolution (p. 366) Gets the MixedImportResolution.
Property Model2DBehavior (p. 366) Gets or sets the Model2DBehavior.
Property NamedSelectionKey (p. 366) Gets the NamedSelectionKey.
Property NamedSelections (p. 366) Gets the NamedSelections.
Property Nodes (p. 367) Gets the Nodes.
Property ParameterKey (p. 367) Gets the ParameterKey.
Property Parameters (p. 367) Gets the Parameters.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Property ReaderModeSavesUpdatedFile (p. 367) Gets or sets the ReaderModeSavesUpdatedFile.


Property ScaleFactorValue (p. 367) Gets or sets the ScaleFactorValue.
Property SheetSurfaceArea (p. 367) Gets the SheetSurfaceArea.
Property SmartCADUpdate (p. 368) Gets the SmartCADUpdate.
Property SolidBodies (p. 368) Gets the SolidBodies.
Property Source (p. 368) Gets the Source.
Property StandardDeviation (p. 368) Gets the StandardDeviation.
Property SurfaceArea (p. 368) Gets the SurfaceArea.
Property SurfaceBodies (p. 368) Gets the SurfaceBodies.
Property TemporaryDirectory (p. 369) Gets or sets the TemporaryDirectory.
Property Type (p. 369) Gets the Type.
Property UseAssociativity (p. 369) Gets the UseAssociativity.
Property UseInstances (p. 369) Gets the UseInstances.
Property Volume (p. 369) Gets the Volume.
Property XCentroid (p. 369) Gets the XCentroid.
Property YCentroid (p. 370) Gets the YCentroid.
Property ZCentroid (p. 370) Gets the ZCentroid.
Method AddComment() (p. 370) Creates a new child Comment.
Method AddDistributedMass() (p. 370) Creates a new DistributedMass
Method AddElementOrientation() (p. 370) Creates a new ElementOrientation
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 AddLayeredSection() (p. 371) Creates a new child LayeredSection.
Method AddPointMass() (p. 371) Creates a new PointMass
Method AddSurfaceCoating() (p. 371) Creates a new SurfaceCoating
Method AddThermalPointMass() (p. 371) Creates a new ThermalPointMass
Method AddThickness() (p. 371) Creates a new child Thickness.
Method GetBody(IBaseGeoBody) (p. 372) Gets the Body associated with the given
IGeoBody
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 372)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 372)
Method GetPart(IBaseGeoPart) (p. 373) Gets the Part associated with the given IGeoPart
Method ResetBodyColors() (p. 373) Run the ResetBodyColors action.
Method UpdateGeometryFromSource() (p. 373) Run the UpdateGeometryFromSource action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 359
Ansys.ACT.Automation.Mechanical Namespace

ActiveBodies
Gets the ActiveBodies.

Declaration Syntax
public int ActiveBodies { get; }

AnalysisType
Gets the AnalysisType.

Declaration Syntax
public GeometryDimensionType AnalysisType { get; }

AssignMaterialOnUpdate
Gets or sets the AssignMaterialOnUpdate.

Declaration Syntax
public bool AssignMaterialOnUpdate { set;get; }

AttachFileViaTempFile
Gets or sets the AttachFileViaTempFile.

Declaration Syntax
public bool AttachFileViaTempFile { set;get; }

AttributeKey
Gets the AttributeKey.

Declaration Syntax
public string AttributeKey { get; }

Attributes
Gets the Attributes.

Declaration Syntax
public bool Attributes { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Average
Gets the Average.

Declaration Syntax
public double Average { get; }

Bodies
Gets the Bodies.

Declaration Syntax
public int Bodies { get; }

CanChangeCADUnits
Gets the CanChangeCADUnits.

Declaration Syntax
public bool CanChangeCADUnits { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 361
Ansys.ACT.Automation.Mechanical Namespace

ComparePartsTolerance
Gets the ComparePartsTolerance.

Declaration Syntax
public ComparePartsToleranceType ComparePartsTolerance { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DecomposeDisjointGeometry
Gets the DecomposeDisjointGeometry.

Declaration Syntax
public bool DecomposeDisjointGeometry { get; }

DisplayStyle
Gets or sets the DisplayStyle.

Declaration Syntax
public PrototypeDisplayStyleType DisplayStyle { set;get; }

ElementControl
Gets or sets the ElementControl.

Declaration Syntax
public ElementControl ElementControl { set;get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

EnclosureAndSymmetryProcessing
Gets the EnclosureAndSymmetryProcessing.

Declaration Syntax
public bool EnclosureAndSymmetryProcessing { get; }

EndPlaneRotationAboutX
Gets or sets the EndPlaneRotationAboutX.

Declaration Syntax
public Quantity EndPlaneRotationAboutX { set;get; }

EndPlaneRotationAboutY
Gets or sets the EndPlaneRotationAboutY.

Declaration Syntax
public Quantity EndPlaneRotationAboutY { set;get; }

FiberLength
Gets or sets the FiberLength.

Declaration Syntax
public Quantity FiberLength { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GeometryPreferencesReadOnly
Gets the GeometryPreferencesReadOnly.

Declaration Syntax
public bool GeometryPreferencesReadOnly { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 363
Ansys.ACT.Automation.Mechanical Namespace

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImportCoordinateSystems
Gets the ImportCoordinateSystems.

Declaration Syntax
public bool ImportCoordinateSystems { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPrototypeGroupAuto InternalObject { get; }

LengthUnit
Gets 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

LengthZ
Gets the LengthZ.

Declaration Syntax
public Quantity LengthZ { get; }

LineBodies
Gets the LineBodies.

Declaration Syntax
public bool LineBodies { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

MaterialProperties
Gets the MaterialProperties.

Declaration Syntax
public bool MaterialProperties { get; }

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

MeshMetric
Gets the MeshMetric.

Declaration Syntax
public int MeshMetric { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 365
Ansys.ACT.Automation.Mechanical Namespace

MeshVolume
Gets the MeshVolume.

Declaration Syntax
public Quantity MeshVolume { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public double Minimum { get; }

MixedImportResolution
Gets the MixedImportResolution.

Declaration Syntax
public SecondaryImportPrefType MixedImportResolution { get; }

Model2DBehavior
Gets or sets the Model2DBehavior.

Declaration Syntax
public Model2DBehavior Model2DBehavior { set;get; }

NamedSelectionKey
Gets the NamedSelectionKey.

Declaration Syntax
public string NamedSelectionKey { get; }

NamedSelections
Gets the NamedSelections.

Declaration Syntax
public bool NamedSelections { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

ParameterKey
Gets the ParameterKey.

Declaration Syntax
public string ParameterKey { get; }

Parameters
Gets the Parameters.

Declaration Syntax
public ImportParameterType Parameters { get; }

ReaderModeSavesUpdatedFile
Gets or sets the ReaderModeSavesUpdatedFile.

Declaration Syntax
public bool ReaderModeSavesUpdatedFile { set;get; }

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Declaration Syntax
public double ScaleFactorValue { set;get; }

SheetSurfaceArea
Gets the SheetSurfaceArea.

Declaration Syntax
public Quantity SheetSurfaceArea { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 367
Ansys.ACT.Automation.Mechanical Namespace

SmartCADUpdate
Gets the SmartCADUpdate.

Declaration Syntax
public bool SmartCADUpdate { get; }

SolidBodies
Gets the SolidBodies.

Declaration Syntax
public bool SolidBodies { get; }

Source
Gets the Source.

Declaration Syntax
public string Source { get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public double StandardDeviation { get; }

SurfaceArea
Gets the SurfaceArea.

Declaration Syntax
public Quantity SurfaceArea { get; }

SurfaceBodies
Gets the SurfaceBodies.

Declaration Syntax
public bool SurfaceBodies { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

TemporaryDirectory
Gets or sets the TemporaryDirectory.

Declaration Syntax
public string TemporaryDirectory { set;get; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 369
Ansys.ACT.Automation.Mechanical Namespace

YCentroid
Gets the YCentroid.

Declaration Syntax
public Quantity YCentroid { get; }

ZCentroid
Gets the ZCentroid.

Declaration Syntax
public Quantity ZCentroid { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 371
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Thickness AddThickness()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
GlobalVonMisesStressConstraint

children(IList<DataModelObject>)
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.

ResetBodyColors()
Run the ResetBodyColors action.

Declaration Syntax
public virtual void ResetBodyColors()

UpdateGeometryFromSource()
Run the UpdateGeometryFromSource action.

Declaration Syntax
public virtual void UpdateGeometryFromSource()

GlobalVonMisesStressConstraint
Defines a GlobalVonMisesStressConstraint.

Declaration Syntax
public class GlobalVonMisesStressConstraint : ResponseConstraint

Table 153: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 374)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 373
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 374) Gets the internal object. For advanced usage only.
Property Maximum (p. 374) Gets or sets the Maximum.
Property ScopingMethod (p. 374) Gets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)

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 the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

Image
Defines a Image.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
Image

Declaration Syntax
public class Image : DataModelObject, IFolderDataModelObject

Table 154: Members

Property Children (p. 375) Gets the list of children.


Property Comments (p. 375) Gets the list of associated comments.
Property DataModelObjectCategory (p. 375) Gets the current DataModelObject's category.
Property Images (p. 376) Gets the list of associated images.
Property InternalObject (p. 376) Gets the internal object. For advanced usage only.
Method AddComment() (p. 376) Creates a new child Comment.
Method AddImage(string) (p. 376) Creates a new child Image. If a 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. 376) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 376)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 377)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 375
Ansys.ACT.Automation.Mechanical Namespace

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)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedBoltPretensions

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ImportedBoltPretensions
Defines a ImportedBoltPretensions.

Declaration Syntax
public class ImportedBoltPretensions : ExternalModelDataColl

Table 155: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 377
Ansys.ACT.Automation.Mechanical Namespace

Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 378)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 378) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

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; }

ImportedConstraintEquations
Defines a ImportedConstraintEquations.

Declaration Syntax
public class ImportedConstraintEquations : ExternalModelDataColl

Table 156: Members

Property Children (p. 323) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedContacts

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 379)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 379) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedContacts
Defines a ImportedContacts.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ImportedContacts : ExternalModelDataColl

Table 157: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 380)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 380) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedCoordinateSystems

ImportedCoordinateSystems
Defines a ImportedCoordinateSystems.

Declaration Syntax
public class ImportedCoordinateSystems : ExternalModelDataColl

Table 158: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 381)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 381) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedElementOrientations
Defines a ImportedElementOrientations.

Declaration Syntax
public class ImportedElementOrientations : ExternalModelDataColl

Table 159: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 382)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 383) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedFlexibleRemoteConnectors

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 160: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 383)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 384) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
Ansys.ACT.Automation.Mechanical Namespace

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 161: Members

Property Children (p. 319) Gets the list of children.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Comments (p. 319) Gets the list of associated comments.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property DataModelObjectCategory (p. 385) Gets the current DataModelObject's
category.
Property Figures (p. 319) Gets the list of associated figures.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Images (p. 320) Gets the list of associated images.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property InternalObject (p. 385) Gets the internal object. For advanced usage
only.
Property LayerToDisplay (p. 320) Gets or sets the LayerToDisplay.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property MaximumNumberOfLayers (p. 320) Gets the MaximumNumberOfLayers.

(Inherited from
ExternalEnhancedModel (p. 318).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedNodalOrientations

Property NonlinearEffects (p. 320) Gets or sets the NonlinearEffects.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Suppressed (p. 320) Gets or sets the Suppressed.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property ThermalStrainEffects (p. 321) Gets or sets the ThermalStrainEffects.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Type (p. 321) Gets the Type.

(Inherited from
ExternalEnhancedModel (p. 318).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalEnhancedModelAuto InternalObject { get; }

ImportedNodalOrientations
Defines a ImportedNodalOrientations.

Declaration Syntax
public class ImportedNodalOrientations : ExternalModelDataColl

Table 162: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 386)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 386) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedObject
Defines a row object in Imported Objects.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedObject

Declaration Syntax
public class ImportedObject

Table 163: Members

Property Active (p. 387) This property sets the object to active or inactive
status
Property InternalObject (p. 387) Gets the internal object. For advanced usage only.
Method GetPropertyNames() (p. 387) This method gives the complete list of property
names that are supported.
Method GetPropertyValueAsString(string) (p. 387) Data in string format that is present on the
columns
Method SetPropertyValue(string, object) (p. 388) Set the data for a give property name

Active
This property sets the object to active or inactive status

Declaration Syntax
public bool Active { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSWorksheetRowDataAuto InternalObject { get; }

GetPropertyNames()
This method gives the complete list of property names that are supported.

Declaration Syntax
public IEnumerable<string> GetPropertyNames()

GetPropertyValueAsString(string)
Data in string format that is present on the columns

Declaration Syntax
public string GetPropertyValueAsString(string name)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
Ansys.ACT.Automation.Mechanical Namespace

Parameters
name(string)
No details are provided for this entry.

SetPropertyValue(string, object)
Set the data for a give property name

Declaration Syntax
public void SetPropertyValue(string name, object value)

Parameters
name(string)
No details are provided for this entry.

value(object)
No details are provided for this entry.

ImportedPlies
Defines a ImportedPlies.

Declaration Syntax
public class ImportedPlies : ExternalEnhancedModel

Table 164: Members

Property Children (p. 319) Gets the list of children.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Comments (p. 319) Gets the list of associated comments.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property DataModelObjectCategory (p. 389) Gets the current DataModelObject's
category.
Property Figures (p. 319) Gets the list of associated figures.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Images (p. 320) Gets the list of associated images.

(Inherited from
ExternalEnhancedModel (p. 318).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedPointMasses

Property InternalObject (p. 389) Gets the internal object. For advanced usage
only.
Property LayerToDisplay (p. 320) Gets or sets the LayerToDisplay.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property MaximumNumberOfLayers (p. 320) Gets the MaximumNumberOfLayers.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property NonlinearEffects (p. 320) Gets or sets the NonlinearEffects.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Suppressed (p. 320) Gets or sets the Suppressed.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property ThermalStrainEffects (p. 321) Gets or sets the ThermalStrainEffects.

(Inherited from
ExternalEnhancedModel (p. 318).)
Property Type (p. 321) Gets the Type.

(Inherited from
ExternalEnhancedModel (p. 318).)

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; }

ImportedPointMasses
Defines a ImportedPointMasses.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 389
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ImportedPointMasses : ExternalModelDataColl

Table 165: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 390)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 390) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedPremeshedBoltPretensions

ImportedPremeshedBoltPretensions
Defines a ImportedPremeshedBoltPretensions.

Declaration Syntax
public class ImportedPremeshedBoltPretensions : ExternalModelDataColl

Table 166: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 391)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 391) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 391
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedRigidRemoteConnectors
Defines a ImportedRigidRemoteConnectors.

Declaration Syntax
public class ImportedRigidRemoteConnectors : ExternalModelDataColl

Table 167: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 392)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 393) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedShellThicknesses

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedShellThicknesses
Defines a ImportedShellThicknesses.

Declaration Syntax
public class ImportedShellThicknesses : ExternalModelDataColl

Table 168: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 393)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 394) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 393
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedSpringConnectors
Defines a ImportedSpringConnectors.

Declaration Syntax
public class ImportedSpringConnectors : ExternalModelDataColl

Table 169: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 395)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)
Property InternalObject (p. 395) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedStresses

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedStresses
Defines a ImportedStresses.

Declaration Syntax
public class ImportedStresses : ExternalModelDataColl

Table 170: Members

Property Children (p. 323) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Comments (p. 323) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Count (p. 323) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 322).)
Property DataModelObjectCategory (p. 396)Gets the current DataModelObject's
category.
Property Figures (p. 324) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 322).)
Property Images (p. 324) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 322).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 395
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 396) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 324) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 322).)

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 171: Members

Property Children (p. 398) Gets the list of children.


Property Comments (p. 398) Gets the list of associated comments.
Property ContactStatus (p. 398) Gets or sets the ContactStatus.
Property CoordinateSystem (p. 399) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 399) Gets the current DataModelObject's
category.
Property DefineBy (p. 399) Gets or sets the DefineBy.
Property Direction (p. 399) Gets or sets the Direction.
Property DropDirection (p. 399) Gets or sets the DropDirection.
Property DropHeight (p. 399) Gets or sets the DropHeight.
Property DropTestDefineBy (p. 400) Gets or sets the DropTestDefineBy.
Property ExplicitPreStressTime (p. 400) Gets or sets the ExplicitPreStressTime.
Property Figures (p. 400) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

Property Images (p. 400) Gets the list of associated images.


Property ImpactVelocity (p. 400) Gets or sets the ImpactVelocity.
Property InitialEnvironment (p. 400) Gets or sets the InitialEnvironment.
Property InitialTemperature (p. 401) Gets the InitialTemperature.
Property InitialTemperatureValue (p. 401) Gets or sets the
InitialTemperatureValue.
Property InputType (p. 401) Gets or sets the InputType.
Property InternalObject (p. 401) Gets the internal object. For advanced
usage only.
Property Location (p. 401) Gets or sets the Location.
Property ModalEnvironmentHarmonicIC ***OBSOLETE*** Gets or sets the
Use 'ModalICEnvironment' property ModalEnvironmentHarmonicIC.
instead. (p. 401)
Property ModalEnvironmentPSDIC ***OBSOLETE*** Use Gets or sets the
'ModalICEnvironment' property instead. (p. 402) ModalEnvironmentPSDIC.
Property ModalEnvironmentRSIC ***OBSOLETE*** Use Gets or sets the
'ModalICEnvironment' property instead. (p. 402) ModalEnvironmentRSIC.
Property ModalEnvironmentTransientMSUPIC Gets or sets the
***OBSOLETE*** Use 'ModalICEnvironment' ModalEnvironmentTransientMSUPIC.
property instead. (p. 402)
Property ModalICEnvironment (p. 402) Gets or sets the ModalICEnvironment.
Property Mode (p. 402) Gets or sets the Mode.
Property NewtonRaphsonOption (p. 403) Gets the NewtonRaphsonOption.
Property PressureInitialization (p. 403) Gets or sets the PressureInitialization.
Property PreStressDefineBy (p. 403) Gets or sets the PreStressDefineBy.
Property PreStressEnvironmentHarmonicIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentHarmonicIC.
instead. (p. 403)
Property PreStressEnvironmentHarmonicMSUPModal (p. 403) Gets the
PreStressEnvironmentHarmonicMSUPModal.
Property PreStressEnvironmentModalIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentModalIC.
instead. (p. 403)
Property PreStressEnvironmentTransientIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentTransientIC.
instead. (p. 404)
Property PreStressEnvironmentTransientMSUPModal (p. 404) Gets the
PreStressEnvironmentTransientMSUPModal.
Property PreStressICEnvironment (p. 404) Gets or sets the
PreStressICEnvironment.
Property PreStressLoadStep (p. 404) Gets or sets the PreStressLoadStep.
Property PreStressTime (p. 404) Gets or sets the PreStressTime.
Property ReferenceTemperature (p. 404) Gets or sets the
ReferenceTemperature.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 397
Ansys.ACT.Automation.Mechanical Namespace

Property ReportedLoadStep (p. 405) Gets the ReportedLoadStep.


Property ReportedSubStep (p. 405) Gets the ReportedSubStep.
Property ReportedTime (p. 405) Gets the ReportedTime.
Property Suppressed (p. 405) Gets or sets the Suppressed.
Property Time (p. 405) Gets or sets the Time.
Property TimeStepFactor (p. 405) Gets or sets the TimeStepFactor.
Property TotalMagnitude (p. 406) Gets or sets the Magnitude.
Property XComponent (p. 406) Gets or sets the XComponent.
Property YComponent (p. 406) Gets or sets the YComponent.
Property ZComponent (p. 406) Gets or sets the ZComponent.
Method AddCommandSnippet() (p. 406) Creates a new child
CommandSnippet.
Method AddComment() (p. 406) Creates a new child Comment.
Method AddFigure() (p. 407) Creates a new child Figure.
Method AddImage(string) (p. 407) Creates a new child Image. If a
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. 407) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 407) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<DataModelObject>) (p. 408) type.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ContactStatus
Gets or sets the ContactStatus.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
398 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 399
Ansys.ACT.Automation.Mechanical Namespace

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
400 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; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ModalEnvironmentHarmonicIC ***OBSOLETE*** Use 'ModalICEnvironment'


property instead.
Gets or sets the ModalEnvironmentHarmonicIC.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 401
Ansys.ACT.Automation.Mechanical Namespace

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; }

Mode
Gets or sets the Mode.

Declaration Syntax
public PreStressMode Mode { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

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; }

PreStressEnvironmentModalIC ***OBSOLETE*** Use 'PreStressICEnviron-


ment' property instead.
Gets or sets the PreStressEnvironmentModalIC.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 403
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public Quantity PreStressTime { set;get; }

ReferenceTemperature
Gets or sets the ReferenceTemperature.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
404 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

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.

Declaration Syntax
public Quantity Time { set;get; }

TimeStepFactor
Gets or sets the TimeStepFactor.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 405
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

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.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
Ansys.ACT.Automation.Mechanical Namespace

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 172: Members

Property Children (p. 409) Gets the list of children.


Property Comments (p. 409) Gets the list of associated comments.
Property DataModelObjectCategory (p. 409) Gets the current DataModelObject's category.
Property Figures (p. 409) Gets the list of associated figures.
Property Images (p. 409) Gets the list of associated images.
Property InternalObject (p. 409) Gets the internal object. For advanced usage only.
Method AddComment() (p. 410) Creates a new child Comment.
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 GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 410)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 411)
Method InsertAngularVelocity() (p. 411) Creates a new Angular Velocity

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialConditions

Method InsertDropHeight() (p. 411) Creates a new Drop Height


Method InsertVelocity() (p. 411) Creates a new Velocity

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSInitialConditionGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
InterfaceDelamination

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

InsertAngularVelocity()
Creates a new Angular Velocity

Declaration Syntax
public virtual InitialCondition InsertAngularVelocity()

InsertDropHeight()
Creates a new Drop Height

Declaration Syntax
public virtual InitialCondition InsertDropHeight()

InsertVelocity()
Creates a new Velocity

Declaration Syntax
public virtual InitialCondition InsertVelocity()

InterfaceDelamination
Defines a InterfaceDelamination.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class InterfaceDelamination : GenericDelamination

Table 173: Members

Property AutomaticTimeStepping (p. 412) Gets or sets the AutomaticTimeStepping.


Property Children (p. 351) Gets the list of children.

(Inherited from GenericDelamination (p. 350).)


Property Comments (p. 351) Gets the list of associated comments.

(Inherited from GenericDelamination (p. 350).)


Property CriticalRate (p. 413) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 413) Gets the current DataModelObject's
category.
Property DistanceTolerance (p. 413) Gets or sets the DistanceTolerance.
Property FailureCriteriaOption (p. 413) Gets or sets the FailureCriteriaOption.
Property Figures (p. 351) Gets the list of associated figures.

(Inherited from GenericDelamination (p. 350).)


Property GenerationMethod (p. 413) Gets or sets the GenerationMethod.
Property Images (p. 351) Gets the list of associated images.

(Inherited from GenericDelamination (p. 350).)


Property InitialCrack (p. 413) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 414) Gets or sets the InitialTimeStep.
Property InternalObject (p. 414) Gets the internal object. For advanced usage
only.
Property MatchControl (p. 414) Gets or sets the MatchControl.
Property Material (p. 414) Gets or sets the Material.
Property MaximumTimeStep (p. 414) Gets or sets the MaximumTimeStep.
Property Method (p. 414) Gets or sets the Method.
Property MinimumTimeStep (p. 415) Gets or sets the MinimumTimeStep.
Property SourceLocation (p. 415) Gets or sets the SourceLocation.
Property Suppressed (p. 415) Gets or sets the Suppressed.
Property TargetLocation (p. 415) Gets or sets the TargetLocation.
Property ToleranceType (p. 415) Gets or sets the ToleranceType.
Property Type (p. 415) Gets the Type.

AutomaticTimeStepping
Gets or sets the AutomaticTimeStepping.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
InterfaceDelamination

Declaration Syntax
public AutomaticOrManual AutomaticTimeStepping { set;get; }

CriticalRate
Gets or sets the CriticalRate.

Declaration Syntax
public Quantity CriticalRate { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DistanceTolerance
Gets or sets the DistanceTolerance.

Declaration Syntax
public Quantity DistanceTolerance { set;get; }

FailureCriteriaOption
Gets or sets the FailureCriteriaOption.

Declaration Syntax
public DelaminationFailureCriteriaOption FailureCriteriaOption { set;get; }

GenerationMethod
Gets or sets the GenerationMethod.

Declaration Syntax
public DelaminationGenerationMethod GenerationMethod { set;get; }

InitialCrack
Gets or sets the InitialCrack.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public GenericCrack InitialCrack { set;get; }

InitialTimeStep
Gets or sets the InitialTimeStep.

Declaration Syntax
public Quantity InitialTimeStep { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

MatchControl
Gets or sets the MatchControl.

Declaration Syntax
public MatchControl MatchControl { set;get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaximumTimeStep
Gets or sets the MaximumTimeStep.

Declaration Syntax
public Quantity MaximumTimeStep { set;get; }

Method
Gets or sets the Method.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
InterfaceDelamination

Declaration Syntax
public DelaminationMethod Method { set;get; }

MinimumTimeStep
Gets or sets the MinimumTimeStep.

Declaration Syntax
public Quantity MinimumTimeStep { set;get; }

SourceLocation
Gets or sets the SourceLocation.

Declaration Syntax
public ISelectionInfo SourceLocation { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TargetLocation
Gets or sets the TargetLocation.

Declaration Syntax
public ISelectionInfo TargetLocation { set;get; }

ToleranceType
Gets or sets the ToleranceType.

Declaration Syntax
public ToleranceType ToleranceType { set;get; }

Type
Gets the Type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
Ansys.ACT.Automation.Mechanical Namespace

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 174: Members

Method GetBushingDampingPerThetaUnitX(int) (p. 417) Gets the Coefficient for the damping per
ThetaUnitX at the indicated row index.
Method GetBushingDampingPerThetaUnitY(int) (p. 417) Gets the Coefficient for the damping per
ThetaUnitY at the indicated row index.
Method GetBushingDampingPerThetaUnitZ(int) (p. 417) Gets the Coefficient for the damping per
ThetaUnitZ at the indicated row index.
Method GetBushingDampingPerUnitX(int) (p. 418) Gets the Coefficient for the damping per
UnitX at the indicated row index.
Method GetBushingDampingPerUnitY(int) (p. 418) Gets the Coefficient for the damping per
UnitY at the indicated row index.
Method GetBushingDampingPerUnitZ(int) (p. 418) Gets the Coefficient for the damping per
UnitZ at the indicated row index.
Method GetBushingStiffnessPerThetaUnitX(int) (p. 419) Gets the Coefficient for the stiffness per
ThetaUnitX at the indicated row index.
Method GetBushingStiffnessPerThetaUnitY(int) (p. 419) Gets the Coefficient for the stiffness per
ThetaUnitY at the indicated row index.
Method GetBushingStiffnessPerThetaUnitZ(int) (p. 419) Gets the Coefficient for the stiffness per
ThetaUnitZ at the indicated row index.
Method GetBushingStiffnessPerUnitX(int) (p. 419) Gets the Coefficient for the stiffness per
UnitX at the indicated row index.
Method GetBushingStiffnessPerUnitY(int) (p. 420) Gets the Coefficient for the stiffness per
UnitY at the indicated row index.
Method GetBushingStiffnessPerUnitZ(int) (p. 420) 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. 420) ThetaUnitX at the indicated row index.
Method SetBushingDampingPerThetaUnitY(int, Sets the Coefficient for the damping per
double) (p. 420) ThetaUnitY at the indicated row index.
Method SetBushingDampingPerThetaUnitZ(int, Sets the Coefficient for the damping per
double) (p. 421) ThetaUnitZ at the indicated row index.
Method SetBushingDampingPerUnitX(int, Sets the Coefficient for the damping per
double) (p. 421) UnitX at the indicated row index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

Method SetBushingDampingPerUnitY(int, Sets the Coefficient for the damping per


double) (p. 421) UnitY at the indicated row index.
Method SetBushingDampingPerUnitZ(int, Sets the Coefficient for the damping per
double) (p. 422) UnitZ at the indicated row index.
Method SetBushingStiffnessPerThetaUnitX(int, Sets the Coefficient for the stiffness per
double) (p. 422) ThetaUnitX at the indicated row index.
Method SetBushingStiffnessPerThetaUnitY(int, Sets the Coefficient for the stiffness per
double) (p. 422) ThetaUnitY at the indicated row index.
Method SetBushingStiffnessPerThetaUnitZ(int, Sets the Coefficient for the stiffness per
double) (p. 423) ThetaUnitZ at the indicated row index.
Method SetBushingStiffnessPerUnitX(int, Sets the Coefficient for the stiffness per UnitX
double) (p. 423) at the indicated row index.
Method SetBushingStiffnessPerUnitY(int, Sets the Coefficient for the stiffness per UnitY
double) (p. 423) at the indicated row index.
Method SetBushingStiffnessPerUnitZ(int, Sets the Coefficient for the stiffness per UnitZ
double) (p. 424) at the indicated row index.

GetBushingDampingPerThetaUnitX(int)
Gets the Coefficient for the damping per ThetaUnitX at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerThetaUnitX(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 3 and less than 6.

GetBushingDampingPerThetaUnitY(int)
Gets the Coefficient for the damping per ThetaUnitY at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerThetaUnitY(int index)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 417
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double GetBushingDampingPerThetaUnitZ(int index)

Parameters
index(int)
Worksheet row index. Must be equal to 5.

GetBushingDampingPerUnitX(int)
Gets the Coefficient for the damping per UnitX at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerUnitX(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 0 and less than 6.

GetBushingDampingPerUnitY(int)
Gets the Coefficient for the damping per UnitY at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerUnitY(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 1 and less than 6.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
418 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

GetBushingStiffnessPerThetaUnitX(int)
Gets the Coefficient for the stiffness per ThetaUnitX at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerThetaUnitX(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 3 and less than 6.

GetBushingStiffnessPerThetaUnitY(int)
Gets the Coefficient for the stiffness per ThetaUnitY at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerThetaUnitY(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 4 and less than 6.

GetBushingStiffnessPerThetaUnitZ(int)
Gets the Coefficient for the stiffness per ThetaUnitZ at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerThetaUnitZ(int index)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 419
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 0 and less than 6.

GetBushingStiffnessPerUnitY(int)
Gets the Coefficient for the stiffness per UnitY at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerUnitY(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 1 and less than 6.

GetBushingStiffnessPerUnitZ(int)
Gets the Coefficient for the stiffness per UnitZ at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerUnitZ(int index)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 2 and less than 6.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
420 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

Declaration Syntax
public double SetBushingDampingPerThetaUnitY(int index, double newVal)

Parameters
index(int)
Worksheet row index. Must be greater than or equal to 4 and less than 6.

newVal(double)
New value for damping per ThetaUnitY.

SetBushingDampingPerThetaUnitZ(int, double)
Sets the Coefficient for the damping per ThetaUnitZ at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerThetaUnitZ(int index, double newVal)

Parameters
index(int)
Worksheet row index. Must be equal to 5.

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 421
Ansys.ACT.Automation.Mechanical Namespace

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.

SetBushingStiffnessPerThetaUnitY(int, double)
Sets the Coefficient for the stiffness per ThetaUnitY at the indicated row index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
422 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

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.

newVal(double)
New value for stiffness per UnitX.

SetBushingStiffnessPerUnitY(int, double)
Sets the Coefficient for the stiffness per UnitY at the indicated row index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 423
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public class LayeredSection : DataModelObject, IFolderDataModelObject

Table 175: Members

Property Children (p. 425) Gets the list of children.


Property Comments (p. 425) Gets the list of associated comments.
Property CoordinateSystem (p. 425) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 426) Gets the current DataModelObject's category.
Property Figures (p. 426) Gets the list of associated figures.
Property Images (p. 426) Gets the list of associated images.
Property InternalObject (p. 426) Gets the internal object. For advanced usage only.
Property LayeredSectionMembraneOffset (p. 426) Gets or sets the LayeredSectionMembraneOffset.
Property Layers (p. 426) Returns the Layers worksheet associated with
LayeredSection

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
424 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSection

Property LayerToDisplay (p. 427) Gets or sets the LayerToDisplay.


Property Location (p. 427) Gets or sets the Location.
Property NonlinearEffects (p. 427) Gets or sets the NonlinearEffects.
Property OffsetType (p. 427) Gets or sets the OffsetType.
Property Suppressed (p. 427) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 427) Gets or sets the ThermalStrainEffects.
Property TotalMass (p. 428) Gets the TotalMass.
Property TotalThickness (p. 428) Gets the TotalThickness.
Method AddComment() (p. 428) Creates a new child Comment.
Method AddFigure() (p. 428) Creates a new child Figure.
Method AddImage(string) (p. 428) Creates a new child Image. If a 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. 428) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 429)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 429)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 425
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSection

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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 427
Ansys.ACT.Automation.Mechanical Namespace

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()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
428 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSectionWorksheet

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

LayeredSectionWorksheet
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 429
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class LayeredSectionWorksheet : Worksheet

Table 176: Members

Property RowCount (p. 430) Gets the number of entries (rows) in the worksheet.
Method AddThicknessLayer(string, Add a row to the LayeredSectionWorksheet New layers
double, double) (p. 431) are added as the top most layer in the Z direction.
Method DeleteRow(int) (p. 431) Delete a row from the LayeredSectionWorksheet
LayeredSection worksheet indices are zero based and
ordered in the Z direction.
Method GetAngle(int) (p. 431) Gets the angle for the LayeredSection at the row index
specifiied. LayeredSection worksheet indices are zero
based and ordered in the Z direction.
Method GetMaterial(int) (p. 432) Gets the material for the LayeredSection at the row index
specifiied. LayeredSection worksheet indices are zero
based and ordered in the Z direction.
Method GetThickness(int) (p. 432) Gets the thickness for the LayeredSection at the row
index specifiied. LayeredSection worksheet indices are
zero based and ordered in the Z direction.
Method InsertThicknessLayerAbove(string, Insert a new layer to the LayeredSectionWorksheet The
double, double, int) (p. 432) new layer will be inserted above the layer indicated by
the given index.
Method InsertThicknessLayerBelow(string, Insert a new layer to the LayeredSectionWorksheet The
double, double, int) (p. 433) new layer will be inserted below the layer indicated by
the given index.
Method SetAngle(int, double) (p. 433) Set the angle for the LayeredSection at the row index
specifiied. LayeredSection worksheet indices are zero
based and ordered in the Z direction.
Method SetMaterial(int, string) (p. 433) Set the material for the LayeredSection at the row index
specifiied. LayeredSection worksheet indices are zero
based and ordered in the Z direction.
Method SetThickness(int, double) (p. 434) Set the thickness for the LayeredSection at the row index
specifiied. LayeredSection worksheet indices are zero
based and ordered in the Z direction.

RowCount
Gets the number of entries (rows) in the worksheet.

Declaration Syntax
public int RowCount { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
430 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSectionWorksheet

AddThicknessLayer(string, double, double)


Add a row to the LayeredSectionWorksheet New layers are added as the top most layer in the Z dir-
ection.

Declaration Syntax
public virtual int AddThicknessLayer(string materialname, double thickness, double angle)

Parameters
materialname(string)
The name of the material to be used in the new layer.

thickness(double)
The thickness to be used in the new layer

angle(double)
The angle to be used in the new layer

DeleteRow(int)
Delete a row from the LayeredSectionWorksheet LayeredSection worksheet 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. LayeredSection worksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual double GetAngle(int index)

Parameters
index(int)
Worksheet row index

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
Ansys.ACT.Automation.Mechanical Namespace

GetMaterial(int)
Gets the material for the LayeredSection at the row index specifiied. LayeredSection worksheet 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. LayeredSection worksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual double GetThickness(int index)

Parameters
index(int)
Worksheet row index

InsertThicknessLayerAbove(string, double, double, int)


Insert a new layer to the LayeredSectionWorksheet The new layer will be inserted above the layer
indicated by the given index.

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSectionWorksheet

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.

Declaration Syntax
public int InsertThicknessLayerBelow(string materialname, double thickness, double angle, int index)

Parameters
materialname(string)
The name of the material to be used in the new layer.

thickness(double)
The thickness to be used in the new layer

angle(double)
The angle to be used in the new layer

index(int)
Worksheet row index

SetAngle(int, double)
Set the angle for the LayeredSection at the row index specifiied. LayeredSection worksheet 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. LayeredSection worksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual void SetMaterial(int index, string materialname)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 433
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)
Worksheet row index

materialname(string)
New material value

SetThickness(int, double)
Set the thickness for the LayeredSection at the row index specifiied. LayeredSection worksheet 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

LocalVonMisesStressConstraint
Defines a LocalVonMisesStressConstraint.

Declaration Syntax
public class LocalVonMisesStressConstraint : ResponseConstraint

Table 177: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 435)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 435) Gets the internal object. For advanced usage only.
Property Location (p. 435) Gets or sets the Location.
Property Maximum (p. 435) Gets or sets the Maximum.
Property ScopingMethod (p. 435) Gets or sets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
434 of ANSYS, Inc. and its subsidiaries and affiliates.
ManufacturingConstraint

(Inherited from ResponseConstraint (p. 625).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets or sets the Maximum.

Declaration Syntax
public Field Maximum { get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

ManufacturingConstraint
Defines a ManufacturingConstraint.

Defines a ManufacturingConstraint.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 435
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public abstract class ManufacturingConstraint : DataModelObject, IFolderDataModelObject

Table 178: Members

Property Children (p. 436) Gets the list of children.


Property DataModelObjectCategory (p. 436) Gets the current DataModelObject's
category.
Property InternalObject (p. 436) Gets the internal object. For advanced
usage only.
Property Selection (p. 436) Gets or sets the Selection.
Property Suppressed (p. 437) Gets or sets the Suppressed.
Method Delete() (p. 437) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 437)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 437)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Selection
Gets or sets the Selection.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
436 of ANSYS, Inc. and its subsidiaries and affiliates.
ManufacturingConstraint

Declaration Syntax
public OptimizationRegion Selection { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 437
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 179: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 438) Gets the current DataModelObject's category.
Property DefineBy (p. 438) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 439) Gets the internal object. For advanced usage only.
Property PercentageToRetain (p. 439) Gets or sets the PercentageToRetain.
Property PercentageToRetainMax (p. 439) Gets or sets the PercentageToRetainMax.
Property PercentageToRetainMin (p. 439) Gets or sets the PercentageToRetainMin.
Property ScopingMethod (p. 439) Gets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineBy
Gets or sets the DefineBy.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
438 of ANSYS, Inc. and its subsidiaries and affiliates.
Material

Declaration Syntax
public ResponseConstraintDefineBy DefineBy { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { 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 the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

Material
Defines a Material.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 439
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class Material : DataModelObject, IFolderDataModelObject

Table 180: Members

Property AssignedBodies (p. 440) Gets the AssignedBodies.


Property Children (p. 440) Gets the list of children.
Property Comments (p. 440) Gets the list of associated comments.
Property DataModelObjectCategory (p. 441) Gets the current DataModelObject's category.
Property Figures (p. 441) Gets the list of associated figures.
Property Images (p. 441) Gets the list of associated images.
Property InternalObject (p. 441) Gets the internal object. For advanced usage only.
Method AddComment() (p. 441) Creates a new child Comment.
Method AddFigure() (p. 441) Creates a new child Figure.
Method AddImage(string) (p. 442) Creates a new child Image. If a 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 CreateMaterialAssignment() (p. 442) Run the CreateMaterialAssignment action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 442)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 442)

AssignedBodies
Gets the AssignedBodies.

Declaration Syntax
public int AssignedBodies { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
440 of ANSYS, Inc. and its subsidiaries and affiliates.
Material

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()

AddFigure()
Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 441
Ansys.ACT.Automation.Mechanical Namespace

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.

CreateMaterialAssignment()
Run the CreateMaterialAssignment action.

Declaration Syntax
public virtual MaterialAssignment CreateMaterialAssignment()

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<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
442 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialAssignment

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

MaterialAssignment
Defines a MaterialAssignment.

Declaration Syntax
public class MaterialAssignment : DataModelObject, IFolderDataModelObject

Table 181: Members

Property Children (p. 444) Gets the list of children.


Property Comments (p. 444) Gets the list of associated comments.
Property DataModelObjectCategory (p. 444) Gets the current DataModelObject's category.
Property FieldCoordinateSystem (p. 444) Gets or sets the FieldCoordinateSystem.
Property Figures (p. 444) Gets the list of associated figures.
Property Images (p. 445) Gets the list of associated images.
Property InternalObject (p. 445) Gets the internal object. For advanced usage only.
Property Location (p. 445) Gets or sets the Location.
Property Material (p. 445) Gets or sets the Material.
Property MaterialName ***OBSOLETE*** Use Gets or sets the MaterialName.
'Material' property instead. (p. 445)
Property NonlinearEffects (p. 445) Gets or sets the NonlinearEffects.
Property ReadOnly (p. 446) Gets the ReadOnly.
Property ReferenceTemperatureValue (p. 446) Gets or sets the ReferenceTemperatureValue.
Property Suppressed (p. 446) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 446) Gets or sets the ThermalStrainEffects.
Property UseReferenceTemperatureByBody (p. 446) Gets or sets the UseReferenceTemperatureByBody.
Method AddCommandSnippet() (p. 446) Creates a new CommandSnippet
Method AddComment() (p. 447) Creates a new child Comment.
Method AddFigure() (p. 447) Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 443
Ansys.ACT.Automation.Mechanical Namespace

Method AddImage(string) (p. 447) Creates a new child Image. If a 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. 447) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 447)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 448)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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; }

FieldCoordinateSystem
Gets or sets the FieldCoordinateSystem.

Declaration Syntax
public CoordinateSystem FieldCoordinateSystem { set;get; }

Figures
Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
444 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialAssignment

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMaterialAssignmentAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 445
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool NonlinearEffects { set;get; }

ReadOnly
Gets the ReadOnly.

Declaration Syntax
public bool ReadOnly { 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; }

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
446 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialAssignment

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 447
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 182: Members

Property Children (p. 449) Gets the list of children.


Property DataModelObjectCategory (p. 449) Gets the current DataModelObject's
category.
Property InternalObject (p. 449) Gets the internal object. For advanced
usage only.
Property Location (p. 449) Gets or sets the Location.
Property MaterialProperty (p. 449) Gets or sets the MaterialProperty.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
448 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialPlot

Property MaterialPropertyComponent (p. 450) Gets or sets the


MaterialPropertyComponent.
Property Suppressed (p. 450) Gets or sets the Suppressed.
Method Clear() (p. 450) Run the Clear action.
Method Delete() (p. 450) Run the Delete action.
Method Generate() (p. 450) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 450)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 451)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 449
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public string MaterialProperty { set;get; }

MaterialPropertyComponent
Gets or sets the MaterialPropertyComponent.

Declaration Syntax
public string MaterialPropertyComponent { set;get; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
450 of ANSYS, Inc. and its subsidiaries and affiliates.
Materials

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject, IFolderDataModelObject

Table 183: Members

Property Children (p. 452) Gets the list of children.


Property Comments (p. 452) Gets the list of associated comments.
Property DataModelObjectCategory (p. 452) Gets the current DataModelObject's category.
Property Figures (p. 452) Gets the list of associated figures.
Property Images (p. 453) Gets the list of associated images.
Property InternalObject (p. 453) Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 451
Ansys.ACT.Automation.Mechanical Namespace

Property MaterialAssignments (p. 453) Gets the MaterialAssignments.


Property MaterialCount (p. 453) Gets the MaterialCount.
Method AddComment() (p. 453) Creates a new child Comment.
Method AddFigure() (p. 453) Creates a new child Figure.
Method AddImage(string) (p. 454) Creates a new child Image. If a 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. 454) Creates a new MaterialAssignment
Method AddMaterialCombination() (p. 454) Creates a new MaterialCombination
Method AddMaterialPlot() (p. 454) Creates a new MaterialPlot
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 454)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 455)
Method RefreshMaterials() (p. 455) Run the RefreshMaterials action.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
452 of ANSYS, Inc. and its subsidiaries and affiliates.
Materials

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMaterialGroupAuto InternalObject { get; }

MaterialAssignments
Gets the MaterialAssignments.

Declaration Syntax
public int MaterialAssignments { get; }

MaterialCount
Gets the MaterialCount.

Declaration Syntax
public int MaterialCount { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 453
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual 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()
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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
MemberSizeManufacturingConstraint

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 455
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class MemberSizeManufacturingConstraint : ManufacturingConstraint

Table 184: Members

Property Children (p. 436) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 435).)
Property DataModelObjectCategory (p. 456)Gets the current DataModelObject's
category.
Property InternalObject (p. 456) Gets the internal object. For advanced usage
only.
Property Maximum (p. 456) Gets or sets the Maximum.
Property MaxSize (p. 457) Gets or sets the MaxSize.
Property Minimum (p. 457) Gets or sets the Minimum.
Property MinSize (p. 457) Gets or sets the MinSize.
Property ScopingMethod (p. 457) Gets the ScopingMethod.
Property Selection (p. 436) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 435).)
Property Suppressed (p. 437) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 435).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
456 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnection

Declaration Syntax
public ManuMemberSizeControlledType Maximum { set;get; }

MaxSize
Gets or sets the MaxSize.

Declaration Syntax
public Quantity MaxSize { set;get; }

Minimum
Gets or sets the Minimum.

Declaration Syntax
public ManuMemberSizeControlledType Minimum { set;get; }

MinSize
Gets or sets the MinSize.

Declaration Syntax
public Quantity MinSize { set;get; }

ScopingMethod
Gets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

MeshConnection
Defines a MeshConnection.

Declaration Syntax
public class MeshConnection : MeshConnectionBase

Table 185: Members

Property Children (p. 461) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 457
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
MeshConnectionBase (p. 460).)
Property Comments (p. 461) Gets the list of associated comments.

(Inherited from
MeshConnectionBase (p. 460).)
Property ContactRegion (p. 459) Gets or sets the ContactRegion.
Property DataModelObjectCategory (p. 459)Gets the current DataModelObject's
category.
Property Figures (p. 461) Gets the list of associated figures.

(Inherited from
MeshConnectionBase (p. 460).)
Property Images (p. 462) Gets the list of associated images.

(Inherited from
MeshConnectionBase (p. 460).)
Property InternalObject (p. 459) Gets the internal object. For advanced usage
only.
Property MasterBodies (p. 462) Gets the MasterBodies.

(Inherited from
MeshConnectionBase (p. 460).)
Property MasterElementSizeFactor (p. 459) Gets or sets the MasterElementSizeFactor.
Property MasterLocation (p. 462) Gets or sets the MasterLocation.

(Inherited from
MeshConnectionBase (p. 460).)
Property ScopeMode (p. 462) Gets the ScopeMode.

(Inherited from
MeshConnectionBase (p. 460).)
Property ScopingMethod (p. 462) No details are provided for this entry.

(Inherited from
MeshConnectionBase (p. 460).)
Property SlaveBodies (p. 463) Gets the SlaveBodies.

(Inherited from
MeshConnectionBase (p. 460).)
Property SlaveLocation (p. 463) Gets or sets the SlaveLocation.

(Inherited from
MeshConnectionBase (p. 460).)
Property SnapToBoundary (p. 463) Gets or sets the SnapToBoundary.

(Inherited from
MeshConnectionBase (p. 460).)
Property SnapTolerance (p. 463) Gets or sets the SnapTolerance.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
458 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnection

(Inherited from
MeshConnectionBase (p. 460).)
Property SnapType (p. 463) Gets or sets the SnapType.

(Inherited from
MeshConnectionBase (p. 460).)
Property Suppressed (p. 463) Gets or sets the Suppressed.

(Inherited from
MeshConnectionBase (p. 460).)
Property ThicknessScaleFactor (p. 460) Gets or sets the ThicknessScaleFactor.
Property ToleranceSlider (p. 464) Gets or sets the ToleranceSlider.

(Inherited from
MeshConnectionBase (p. 460).)
Property ToleranceType (p. 464) Gets or sets the ToleranceType.

(Inherited from
MeshConnectionBase (p. 460).)
Property ToleranceValue (p. 460) Gets or sets the ToleranceValue.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 459
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double MasterElementSizeFactor { set;get; }

ThicknessScaleFactor
Gets or sets the ThicknessScaleFactor.

Declaration Syntax
public double ThicknessScaleFactor { set;get; }

ToleranceValue
Gets or sets the ToleranceValue.

Declaration Syntax
public Quantity ToleranceValue { set;get; }

MeshConnectionBase
Defines a MeshConnectionBase.

Defines a MeshConnectionBase.

Declaration Syntax
public class MeshConnectionBase : DataModelObject, IFolderDataModelObject

Table 186: Members

Property Children (p. 461) Gets the list of children.


Property Comments (p. 461) Gets the list of associated comments.
Property DataModelObjectCategory (p. 461) Gets the current DataModelObject's category.
Property Figures (p. 461) Gets the list of associated figures.
Property Images (p. 462) Gets the list of associated images.
Property InternalObject (p. 462) Gets the internal object. For advanced usage only.
Property MasterBodies (p. 462) Gets the MasterBodies.
Property MasterLocation (p. 462) Gets or sets the MasterLocation.
Property ScopeMode (p. 462) Gets the ScopeMode.
Property ScopingMethod (p. 462) No details are provided for this entry.
Property SlaveBodies (p. 463) Gets the SlaveBodies.
Property SlaveLocation (p. 463) Gets or sets the SlaveLocation.
Property SnapToBoundary (p. 463) Gets or sets the SnapToBoundary.
Property SnapTolerance (p. 463) Gets or sets the SnapTolerance.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
460 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionBase

Property SnapType (p. 463) Gets or sets the SnapType.


Property Suppressed (p. 463) Gets or sets the Suppressed.
Property ToleranceSlider (p. 464) Gets or sets the ToleranceSlider.
Property ToleranceType (p. 464) Gets or sets the ToleranceType.
Method AddComment() (p. 464) Creates a new child Comment.
Method AddFigure() (p. 464) Creates a new child Figure.
Method AddImage(string) (p. 464) Creates a new child Image. If a 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. 465) Run the Delete action.
Method Generate() (p. 465) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 465)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 465)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 461
Ansys.ACT.Automation.Mechanical Namespace

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; }

ScopingMethod
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
462 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionBase

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; }

Suppressed
Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 463
Ansys.ACT.Automation.Mechanical Namespace

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)

Parameters
filePath(string)
Full path of file. Defaults to None.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
464 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionBase

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 465
Ansys.ACT.Automation.Mechanical Namespace

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

MeshConnectionGroup
Defines a MeshConnectionGroup.

Declaration Syntax
public class MeshConnectionGroup : ConnectionGroup

Table 187: Members

Property ActiveConnections (p. 2484) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 2483).)


Property AutomaticFixedJoints (p. 2484) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 2483).)


Property Children (p. 2484) Gets the list of children.

(Inherited from ConnectionGroup (p. 2483).)


Property Comments (p. 2485) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 2483).)


Property Connections (p. 2485) Gets the Connections.

(Inherited from ConnectionGroup (p. 2483).)


Property ConnectionType (p. 2485) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 2483).)


Property CylindricalFaces (p. 2485) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 2483).)


Property DataModelObjectCategory (p. 468) Gets the current DataModelObject's category.
Property EdgeEdge (p. 2485) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 2483).)


Property EdgeOverlapTolerance (p. 2486) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceAngleTolerance (p. 2486) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceEdge (p. 2486) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceFace (p. 2486) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 2483).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
466 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionGroup

Property FaceFaceDetectionAngleTolerence (p. 2486)Gets or sets the


FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceOverlapTolerance (p. 2486) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property Figures (p. 2487) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 2483).)


Property GroupBy (p. 2487) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 2483).)


Property Images (p. 2487) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 2483).)


Property InternalObject (p. 468) Gets the internal object. For advanced usage
only.
Property Location (p. 2487) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 2483).)


Property MinimumDistancePercentage (p. 2487) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 2483).)


Property MinimumDistanceValue (p. 2488) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 2483).)


Property Priority (p. 2488) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 2483).)


Property RevoluteJoints (p. 2488) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 2483).)


Property SearchAcross (p. 2488) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 2483).)


Property Suppressed (p. 2488) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 2483).)


Property ThicknessScaleFactor (p. 2488) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceSlider (p. 2489) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceType (p. 2489) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceValue (p. 2489) Gets or sets the ToleranceValue.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 467
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 2483).)


Property UseRange (p. 2489) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 2483).)


Method AddManualMeshConnection() (p. 468) Creates a new MeshConnection
Method DetectConnections() (p. 468) Detect mesh connections.
Method Generate() (p. 468) Generate mesh connections.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSConnectionGroupAuto InternalObject { get; }

AddManualMeshConnection()
Creates a new MeshConnection

Declaration Syntax
public virtual MeshConnection AddManualMeshConnection()

DetectConnections()
Detect mesh connections.

Declaration Syntax
public virtual void DetectConnections()

Generate()
Generate mesh connections.

Declaration Syntax
public virtual void Generate()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
468 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshControlWorksheet

MeshControlWorksheet
No details are provided for this entry.

Declaration Syntax
public class MeshControlWorksheet : Worksheet

Table 188: Members

Property RowCount (p. 469) Gets the number of entries


Method AddRow() (p. 469) Add a row to the MeshControlWorksheet
Method ClearGenerateMesh() (p. 469) Clear Mesh
Method DeleteAllRows() (p. 470) Delete All Rows
Method DeleteRow(int) (p. 470) Delete a row from the
MeshControlWorksheet
Method GenerateAtRow(int) (p. 470) Generate Mesh At Row
Method GenerateMesh() (p. 470) Geneate Mesh
Method GetActiveState(int) (p. 470) Gets the Active State property at row index
Method GetNamedSelection(int) (p. 471) Gets the NamedSelection at row index
Method GetNamedSelectionId(int) (p. 471) Gets the ID of the NamedSelection at row
index
Method SetActiveState(int, bool) (p. 471) Sets the Active State property at row index
Method SetNamedSelection(int, Sets the NamedSelection at row index
NamedSelection) (p. 472)
Method SetNamedSelectionId(int, uint) (p. 472) 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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 469
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void ClearGenerateMesh()

DeleteAllRows()
Delete All Rows

Declaration Syntax
public virtual void DeleteAllRows()

DeleteRow(int)
Delete a row from the MeshControlWorksheet

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)
No details are provided for this entry.

GenerateAtRow(int)
Generate Mesh At Row

Declaration Syntax
public virtual void GenerateAtRow(int index)

Parameters
index(int)
No details are provided for this entry.

GenerateMesh()
Geneate Mesh

Declaration Syntax
public virtual void GenerateMesh()

GetActiveState(int)
Gets the Active State property at row index

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
470 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshControlWorksheet

Declaration Syntax
public virtual bool GetActiveState(int index)

Parameters
index(int)
No details are provided for this entry.

GetNamedSelection(int)
Gets the NamedSelection at row index

Declaration Syntax
public virtual NamedSelection GetNamedSelection(int index)

Parameters
index(int)
No details are provided for this entry.

GetNamedSelectionId(int)
Gets the ID of the NamedSelection at row index

Declaration Syntax
public virtual uint GetNamedSelectionId(int index)

Parameters
index(int)
No details are provided for this entry.

SetActiveState(int, bool)
Sets the Active State property at row index

Declaration Syntax
public virtual void SetActiveState(int index, bool value)

Parameters
index(int)
No details are provided for this entry.

value(bool)
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 471
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public class MeshEdit : DataModelObject, IFolderDataModelObject

Table 189: 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 Figures (p. 474) Gets the list of associated figures.
Property GenerateAutomaticMeshConnectionsOnRefresh (p. 474) Gets or sets the
GenerateAutomaticMeshConnectionsOnRefresh.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
472 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

Property Images (p. 474) Gets the list of associated images.


Property InternalObject (p. 474) Gets the internal object. For advanced
usage only.
Property TransparencyEnabled (p. 474) Gets or sets the TransparencyEnabled.
Method AddComment() (p. 475) Creates a new child Comment.
Method AddContactMatchGroup() (p. 475) Creates a new ContactMatchGroup
Method AddFigure() (p. 475) Creates a new child Figure.
Method AddImage(string) (p. 475) Creates a new child Image. If a 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. 475) Add a new ManualMeshConnection
Method AddMeshConnectionGroup() (p. 475) Creates a new MeshConnectionGroup
Method AddNodeMerge() (p. 476) Add a new NodeMerge.
Method AddNodeMergeGroup() (p. 476) Creates a new NodeMergeGroup
Method AddNodeMove() (p. 476) Creates a new NodeMove
Method ClearGeneratedData() (p. 476) Clear the generated data.
Method CreateNamedSelectionForSharedNodes() (p. 476) Run the
CreateNamedSelectionForSharedNodes
action.
Method Generate() (p. 476) Generate mesh edit.
Method GenerateAllMeshEdits() (p. 477) Run the GenerateAllMeshEdits action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 477)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 477)
Method SearchConnectionsForDuplicatePairs() (p. 478) Run the
SearchConnectionsForDuplicatePairs
action.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 473
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
474 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddContactMatchGroup()
Creates a new ContactMatchGroup

Declaration Syntax
public virtual ContactMatchGroup AddContactMatchGroup()

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 475
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual MeshConnectionGroup AddMeshConnectionGroup()

AddNodeMerge()
Add a new NodeMerge.

Declaration Syntax
public virtual void AddNodeMerge()

AddNodeMergeGroup()
Creates a new NodeMergeGroup

Declaration Syntax
public virtual NodeMergeGroup AddNodeMergeGroup()

AddNodeMove()
Creates a new NodeMove

Declaration Syntax
public virtual NodeMove AddNodeMove()

ClearGeneratedData()
Clear the generated data.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateNamedSelectionForSharedNodes()
Run the CreateNamedSelectionForSharedNodes action.

Declaration Syntax
public virtual void CreateNamedSelectionForSharedNodes()

Generate()
Generate mesh edit.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
476 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

Declaration Syntax
public virtual void Generate()

GenerateAllMeshEdits()
Run the GenerateAllMeshEdits action.

Declaration Syntax
public virtual void GenerateAllMeshEdits()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
Ansys.ACT.Automation.Mechanical Namespace

SearchConnectionsForDuplicatePairs()
Run the SearchConnectionsForDuplicatePairs action.

Declaration Syntax
public virtual void SearchConnectionsForDuplicatePairs()

MeshNumbering
Defines a MeshNumbering.

Declaration Syntax
public class MeshNumbering : DataModelObject, IFolderDataModelObject

Table 190: Members

Property Children (p. 478) Gets the list of children.


Property Comments (p. 479) Gets the list of associated comments.
Property CompressNodeNumbers (p. 479) Gets or sets the CompressNodeNumbers.
Property DataModelObjectCategory (p. 479) Gets the current DataModelObject's category.
Property ElementOffset (p. 479) Gets or sets the ElementOffset.
Property Figures (p. 479) Gets the list of associated figures.
Property Images (p. 479) Gets the list of associated images.
Property InternalObject (p. 480) Gets the internal object. For advanced usage only.
Property NodeOffset (p. 480) Gets or sets the NodeOffset.
Property Suppressed (p. 480) Gets or sets the Suppressed.
Method AddComment() (p. 480) Creates a new child Comment.
Method AddFigure() (p. 480) Creates a new child Figure.
Method AddImage(string) (p. 480) Creates a new child Image. If a 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. 481) Creates a new NumberingControl
Method Delete() (p. 481) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 481)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 481)
Method RenumberMesh() (p. 482) Run the RenumberMesh action.

Children
Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshNumbering

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 479
Ansys.ACT.Automation.Mechanical Namespace

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
480 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshNumbering

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 481
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 191: Members

Property Ambient (p. 484) Gets or sets the Ambient Lighting factor.
Property AMProcess (p. 485) Gets the AMProcess.
Property Analyses (p. 485) Gets the Analyses.
Property CellId (p. 485) Gets the CellId.
Property Children (p. 485) Gets the list of children.
Property Color (p. 485) 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.
Property Comments (p. 485) Gets the list of associated comments.
Property CondensedGeometry (p. 486) Gets the CondensedGeometry.
Property Connections (p. 486) Gets the Connections.
Property ConstructionGeometry (p. 486) Gets the ConstructionGeometry.
Property Control (p. 486) Gets the Control.
Property CoordinateSystems (p. 486) Gets the CoordinateSystems.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
482 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Property DataModelObjectCategory (p. 486) Gets the current DataModelObject's category.


Property Diffuse (p. 487) Gets or sets the Diffuse Lighting factor.
Property Environments ***OBSOLETE*** Use Gets the Analyses.
'Analyses' property instead. (p. 487)
Property Figures (p. 487) Gets the list of associated figures.
Property Fracture (p. 487) Gets the Fracture.
Property Geometry (p. 487) Gets the Geometry.
Property Images (p. 487) Gets the list of associated images.
Property InternalObject (p. 488) Gets the internal object. For advanced usage
only.
Property Materials (p. 488) Gets the Materials.
Property Mesh (p. 488) Gets the Mesh.
Property MeshEdit (p. 488) Gets the MeshEdit.
Property MeshNumbering (p. 488) Gets the MeshNumbering.
Property NamedSelections (p. 488) Gets the NamedSelections.
Property PartTransformGroup (p. 489) Gets the PartTransformGroup.
Property RemotePoints (p. 489) Gets the RemotePoints.
Property Specular (p. 489) Gets or sets the Specular Lighting factor.
Property Symmetry (p. 489) Gets the Symmetry.
Property SystemCaption (p. 489) Gets the SystemCaption.
Property VirtualTopology (p. 489) Gets the VirtualTopology.
Method AddAMProcess() (p. 490) Creates a new AMProcess
Method AddChart() (p. 490) Creates a new child Chart.
Method AddComment() (p. 490) Creates a new child Comment.
Method AddCondensedGeometry() (p. 490) Creates a new CondensedGeometry
Method AddConnections() (p. 490) Creates a new Connections
Method AddConstructionGeometry() (p. 490) Creates a new ConstructionGeometry
Method AddCoupledFieldStatic() (p. 491) Run the AddCoupledFieldStatic action.
Method AddCoupledFieldTransient() (p. 491) Run the AddCoupledFieldTransient action.
Method AddDesignAssessmentAnalysis() (p. 491) Run the AddDesignAssessmentAnalysis action.
Method AddEigenvalueBucklingAnalysis() (p. 491) Run the AddEigenvalueBucklingAnalysis action.
Method AddElectricAnalysis() (p. 491) Run the AddElectricAnalysis action.
Method AddExplicitDynamicsAnalysis() (p. 491) Run the AddExplicitDynamicsAnalysis action.
Method AddFigure() (p. 492) Creates a new child Figure.
Method AddFracture() (p. 492) Creates a new Fracture
Method AddHarmonicAcousticAnalysis() (p. 492) Run the AddHarmonicAcousticAnalysis action.
Method AddHarmonicResponseAnalysis() (p. 492) Run the AddHarmonicResponseAnalysis action.
Method AddImage(string) (p. 492) Creates a new child Image. If a 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 483
Ansys.ACT.Automation.Mechanical Namespace

Method AddMagnetostaticAnalysis() (p. 492) Run the AddMagnetostaticAnalysis action.


Method AddMeshEdit() (p. 493) Creates a new MeshEdit
Method AddMeshNumbering() (p. 493) Creates a new MeshNumbering
Method AddModalAcousticAnalysis() (p. 493) Run the AddModalAcousticAnalysis action.
Method AddModalAnalysis() (p. 493) Run the AddModalAnalysis action.
Method AddNamedSelection() (p. 493) Creates a new child NamedSelection.
Method AddPartTransform() (p. 493) Creates a new child PartTransform.
Method AddRandomVibrationAnalysis() (p. 494) Run the AddRandomVibrationAnalysis action.
Method AddRemotePoint() (p. 494) Creates a new child RemotePoint.
Method AddResponseSpectrumAnalysis() (p. 494) Run the AddResponseSpectrumAnalysis action.
Method AddRigidDynamicsAnalysis() (p. 494) Run the AddRigidDynamicsAnalysis action.
Method AddSolutionCombination() (p. 494) Creates a new SolutionCombination
Method AddStaticAcousticAnalysis() (p. 494) Run the AddStaticAcousticAnalysis action.
Method AddStaticStructuralAnalysis() (p. 495) Run the AddStaticStructuralAnalysis action.
Method AddSteadyStateThermalAnalysis() (p. 495) Run the AddSteadyStateThermalAnalysis action.
Method AddSymmetry() (p. 495) Creates a new Symmetry
Method AddThermalElectricAnalysis() (p. 495) Run the AddThermalElectricAnalysis action.
Method AddTopologyOptimizationAnalysis() (p. 495) Run the AddTopologyOptimizationAnalysis
action.
Method AddTransientStructuralAnalysis() (p. 495) Run the AddTransientStructuralAnalysis action.
Method AddTransientThermalAnalysis() (p. 496) Run the AddTransientThermalAnalysis action.
Method AddVirtualTopology() (p. 496) Creates a new VirtualTopology
Method ClearGeneratedData() (p. 496) Run the ClearGeneratedData action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 496)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 496)
Method GetFECommandsRepository(string, Gets the commands repository for a file from
string) (p. 497) external model.
Method GetResults() (p. 497) Gets the Results from the server.
Method RefreshMaterials() (p. 497) Run the RefresMaterials action.
Method Solve(bool, SolveConfiguration) (p. 498) Run the Solve action.
Method Solve(bool, string) (p. 498) Run the Solve action.
Method UpdateGeometryFromSource() (p. 498) Run the UpdateGeometryFromSource action.

Ambient
Gets or sets the Ambient Lighting factor.

Declaration Syntax
public double Ambient { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
484 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

AMProcess
Gets the AMProcess.

Declaration Syntax
public AMProcess AMProcess { get; }

Analyses
Gets the Analyses.

Declaration Syntax
public IList<Analysis> Analyses { get; }

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 485
Ansys.ACT.Automation.Mechanical Namespace

CondensedGeometry
Gets the CondensedGeometry.

Declaration Syntax
public CondensedGeometry CondensedGeometry { get; }

Connections
Gets the Connections.

Declaration Syntax
public Connections Connections { get; }

ConstructionGeometry
Gets the ConstructionGeometry.

Declaration Syntax
public ConstructionGeometry ConstructionGeometry { get; }

Control
Gets the Control.

Declaration Syntax
public string Control { get; }

CoordinateSystems
Gets the CoordinateSystems.

Declaration Syntax
public CoordinateSystems CoordinateSystems { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
486 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

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; }

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.

Declaration Syntax
public Geometry Geometry { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 487
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
488 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 489
Ansys.ACT.Automation.Mechanical Namespace

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.

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
490 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

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()

AddEigenvalueBucklingAnalysis()
Run the AddEigenvalueBucklingAnalysis action.

Declaration Syntax
public virtual Analysis AddEigenvalueBucklingAnalysis()

AddElectricAnalysis()
Run the AddElectricAnalysis action.

Declaration Syntax
public virtual Analysis AddElectricAnalysis()

AddExplicitDynamicsAnalysis()
Run the AddExplicitDynamicsAnalysis action.

Declaration Syntax
public virtual Analysis AddExplicitDynamicsAnalysis()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 491
Ansys.ACT.Automation.Mechanical Namespace

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddFracture()
Creates a new Fracture

Declaration Syntax
public virtual Fracture AddFracture()

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.

AddMagnetostaticAnalysis()
Run the AddMagnetostaticAnalysis action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
492 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

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.

Declaration Syntax
public virtual Analysis AddModalAnalysis()

AddNamedSelection()
Creates a new child NamedSelection.

Declaration Syntax
public virtual NamedSelection AddNamedSelection()

AddPartTransform()
Creates a new child PartTransform.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 493
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual PartTransform AddPartTransform()

AddRandomVibrationAnalysis()
Run the AddRandomVibrationAnalysis action.

Declaration Syntax
public virtual Analysis AddRandomVibrationAnalysis()

AddRemotePoint()
Creates a new child RemotePoint.

Declaration Syntax
public virtual RemotePoint AddRemotePoint()

AddResponseSpectrumAnalysis()
Run the AddResponseSpectrumAnalysis action.

Declaration Syntax
public virtual Analysis AddResponseSpectrumAnalysis()

AddRigidDynamicsAnalysis()
Run the AddRigidDynamicsAnalysis action.

Declaration Syntax
public virtual Analysis AddRigidDynamicsAnalysis()

AddSolutionCombination()
Creates a new SolutionCombination

Declaration Syntax
public virtual SolutionCombination AddSolutionCombination()

AddStaticAcousticAnalysis()
Run the AddStaticAcousticAnalysis action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
494 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

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()

AddSymmetry()
Creates a new Symmetry

Declaration Syntax
public virtual Symmetry AddSymmetry()

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 495
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Analysis AddTransientStructuralAnalysis()

AddTransientThermalAnalysis()
Run the AddTransientThermalAnalysis action.

Declaration Syntax
public virtual Analysis AddTransientThermalAnalysis()

AddVirtualTopology()
Creates a new VirtualTopology

Declaration Syntax
public virtual VirtualTopology AddVirtualTopology()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

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<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
496 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetFECommandsRepository(string, string)
Gets the commands repository for a file from external model.

Declaration Syntax
public virtual CommandRepository GetFECommandsRepository(string source, string fileIdentifier)

Parameters
source(string)
Source (External Model) Component Id.

fileIdentifier(string)
File Identifier specified in the External Model.

GetResults()
Gets the Results from the server.

Declaration Syntax
public virtual void GetResults()

RefreshMaterials()
Run the RefresMaterials action.

Declaration Syntax
public virtual void RefreshMaterials()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 497
Ansys.ACT.Automation.Mechanical Namespace

Solve(bool, SolveConfiguration)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, SolveConfiguration config)

Parameters
wait(bool)
Wait or not for the solve to be done.

config(SolveConfiguration)
The solve configuration to use. If null, the default.

Solve(bool, string)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, string config)

Parameters
wait(bool)
Wait or not for the solve to be done.

config(string)
The solve configuration to use. Results in a new error message if the input solve configuration does not
exist. If none is provided, the default is used for the solve.

UpdateGeometryFromSource()
Run the UpdateGeometryFromSource action.

Declaration Syntax
public virtual void UpdateGeometryFromSource()

MomentOfInertiaConstraint
Defines a MomentOfInertiaConstraint.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
498 of ANSYS, Inc. and its subsidiaries and affiliates.
MomentOfInertiaConstraint

Declaration Syntax
public class MomentOfInertiaConstraint : DataModelObject

Table 192: Members

Property Axis (p. 499) Gets or sets the Axis.


Property CoordinateSystem (p. 499) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 499) Gets the current DataModelObject's
category.
Property InternalObject (p. 499) Gets the internal object. For advanced usage
only.
Property PercentageToRetainMax (p. 500) Gets or sets the PercentageToRetainMax.
Property PercentageToRetainMin (p. 500) Gets or sets the PercentageToRetainMin.
Property Suppressed (p. 500) Gets or sets the Suppressed.
Method Delete() (p. 500) Run the Delete action.

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 499
Ansys.ACT.Automation.Mechanical Namespace

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; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

NamedSelection
Defines a NamedSelection.

Declaration Syntax
public class NamedSelection : DataModelObject, IMechanicalSelectionInfo, ISelectionInfo, IFolderDataMod-
elObject

Table 193: Members

Property Children (p. 501) Gets the list of children.


Property Comments (p. 502) Gets the list of associated comments.
Property DataModelObjectCategory (p. 502) Gets the current DataModelObject's
category.
Property Figures (p. 502) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
500 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

Property GenerationCriteria (p. 502) Returns the generation criteria that is used
to generate the selection.
Property Images (p. 502) Gets the list of associated images.
Property IncludeProgramControlledInflation (p. 502) Gets or sets the
IncludeProgramControlledInflation.
Property InternalObject (p. 503) Gets the internal object. For advanced
usage only.
Property Location ***OBSOLETE*** Use the Gets or sets the Location.
GenerationCriteria property to alter worksheet
data instead. (p. 503)
Property RelativeTolerance (p. 503) Gets or sets the RelativeTolerance.
Property ScopingMethod (p. 503) Gets or sets the ScopingMethod.
Property SendAs (p. 503) Gets or sets the SendAs.
Property SendToSolver (p. 503) Gets or sets the SendToSolver.
Property Suppressed (p. 504) Gets the Suppressed.
Property ToleranceType (p. 504) Gets or sets the ToleranceType.
Property TotalSelection (p. 504) Gets the TotalSelection.
Property Type (p. 504) Gets the Type.
Property UsedByMeshWorksheet (p. 504) Gets the UsedByMeshWorksheet.
Property Visible (p. 504) Gets or sets the Visible.
Property ZeroTolerance (p. 505) Gets or sets the ZeroTolerance.
Method AddComment() (p. 505) Creates a new child Comment.
Method AddFigure() (p. 505) Creates a new child Figure.
Method AddImage(string) (p. 505) Creates a new child Image. If a 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. 505) Run the Delete action.
Method ExportNamedSelectionToCDBFile(string) (p. 505) Export Named Selection to CDB file
Method ExportToTextFile(string) (p. 506) Run the ExportToTextFile action.
Method Generate() (p. 506) Generates the selection based on the
generation criteria.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 506)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 506)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 501
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
502 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSComponentAuto InternalObject { get; }

Location ***OBSOLETE*** Use the GenerationCriteria property to alter


worksheet data instead.
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 503
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets the Suppressed.

Declaration Syntax
public int Suppressed { get; }

ToleranceType
Gets or sets the ToleranceType.

Declaration Syntax
public ToleranceType ToleranceType { set;get; }

TotalSelection
Gets the TotalSelection.

Declaration Syntax
public int TotalSelection { get; }

Type
Gets the Type.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
504 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

ZeroTolerance
Gets or sets the ZeroTolerance.

Declaration Syntax
public double ZeroTolerance { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

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()

ExportNamedSelectionToCDBFile(string)
Export Named Selection to CDB file

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 505
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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.

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<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
506 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelectionCriteria

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 194: Members

Property Count (p. 507) The number of criteria in the collection.


Property Item (p. 508) The criterion at the given index.
Method Add(NamedSelectionCriterion) (p. 508) Adds the given criterion to the collection.
Method Clear() (p. 508) Clears the collection.
Method Contains(NamedSelectionCriterion) (p. 508) Returns whether the collection contains the
given criterion.
Method IndexOf(NamedSelectionCriterion) (p. 508) Returns the index of the given criterion if it
exists in the collection. Returns -1 if it does not
Method Insert(int, Inserts the given criterion into the collection at
NamedSelectionCriterion) (p. 509) the given index.
Method Remove(NamedSelectionCriterion) (p. 509) Removes the given criterion from the collection
if it exists in the collection. Throws an exception
if it does not.
Method RemoveAt(int) (p. 509) 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 507
Ansys.ACT.Automation.Mechanical Namespace

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()

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
508 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelectionCriteria

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.

Declaration Syntax
public virtual bool Remove(NamedSelectionCriterion criterion)

Parameters
criterion(NamedSelectionCriterion)
No details are provided for this entry.

RemoveAt(int)
Removes the criterion at the given index. Throws an exception if the given index is not valid.

Declaration Syntax
public virtual void RemoveAt(int index)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 509
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)
No details are provided for this entry.

NamedSelectionCriterion
No details are provided for this entry.

Declaration Syntax
public class NamedSelectionCriterion

Table 195: Members

Constructor NamedSelectionCriterion(bool, Creates a new NamedSelectionCriterion


SelectionActionType, SelectionType, instance with the provided properties.
SelectionCriterionType,
SelectionOperatorType, object, Quantity,
Quantity, CoordinateSystem) (p. 510)
Property Action (p. 511) No details are provided for this entry.
Property Active (p. 511) No details are provided for this entry.
Property CoordinateSystem (p. 511) No details are provided for this entry.
Property Criterion (p. 511) No details are provided for this entry.
Property EntityType (p. 512) No details are provided for this entry.
Property LowerBound (p. 512) No details are provided for this entry.
Property Operator (p. 512) No details are provided for this entry.
Property UpperBound (p. 512) No details are provided for this entry.
Property Value (p. 512) 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
510 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelectionCriterion

actionType(SelectionActionType)
No details are provided for this entry.

entityType(SelectionType)
No details are provided for this entry.

criterionType(SelectionCriterionType)
No details are provided for this entry.

operatorType(SelectionOperatorType)
No details are provided for this entry.

value(object)
No details are provided for this entry.

lowerBound(Quantity)
No details are provided for this entry.

upperBound(Quantity)
No details are provided for this entry.

coordinateSystem(CoordinateSystem)
No details are provided for this entry.

Action
No details are provided for this entry.

Declaration Syntax
public SelectionActionType Action { set;get; }

Active
No details are provided for this entry.

Declaration Syntax
public bool Active { set;get; }

CoordinateSystem
No details are provided for this entry.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Criterion
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 511
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public SelectionCriterionType Criterion { set;get; }

EntityType
No details are provided for this entry.

Declaration Syntax
public SelectionType EntityType { set;get; }

LowerBound
No details are provided for this entry.

Declaration Syntax
public object LowerBound { set;get; }

Operator
No details are provided for this entry.

Declaration Syntax
public SelectionOperatorType Operator { set;get; }

UpperBound
No details are provided for this entry.

Declaration Syntax
public object UpperBound { set;get; }

Value
No details are provided for this entry.

Declaration Syntax
public object Value { set;get; }

NamedSelections
Defines a NamedSelections.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
512 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelections

Declaration Syntax
public class NamedSelections : DataModelObject, IFolderDataModelObject

Table 196: Members

Property Children (p. 513) Gets the list of children.


Property Comments (p. 513) Gets the list of associated comments.
Property DataModelObjectCategory (p. 514) Gets the current DataModelObject's category.
Property Figures (p. 514) Gets the list of associated figures.
Property GenerateOnRefresh (p. 514) Gets or sets the GenerateOnRefresh.
Property GenerateOnRemesh (p. 514) Gets or sets the GenerateOnRemesh.
Property Images (p. 514) Gets the list of associated images.
Property InternalObject (p. 514) Gets the internal object. For advanced usage only.
Property RandomColors (p. 515) Gets the RandomColors.
Property ShowAnnotations (p. 515) Gets or sets the ShowAnnotations.
Method AddComment() (p. 515) Creates a new child Comment.
Method AddFigure() (p. 515) Creates a new child Figure.
Method AddImage(string) (p. 515) Creates a new child Image. If a 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. 515) Creates a new NamedSelection
Method Delete() (p. 516) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 516)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 516)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 513
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerateOnRefresh
Gets or sets the GenerateOnRefresh.

Declaration Syntax
public bool GenerateOnRefresh { set;get; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
514 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelections

RandomColors
Gets the RandomColors.

Declaration Syntax
public bool RandomColors { get; }

ShowAnnotations
Gets or sets the ShowAnnotations.

Declaration Syntax
public bool ShowAnnotations { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 515
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual NamedSelection AddNamedSelection()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
516 of ANSYS, Inc. and its subsidiaries and affiliates.
NastranExportOptions

NastranExportOptions
Defines the NastranExportOptions.

Declaration Syntax
public class NastranExportOptions : Dictionary<string, object>

Table 197: Members

Constructor NastranExportOptions(string, string, int, int, double, No details are provided for this
double, string, int, double, bool) (p. 517) entry.
Property AnalysisType (p. 518) Analysis type.
Property GridCS (p. 518) Grid coordinate system
number.
Property GroundCheck (p. 518) Ground check.
Property JointStiffness (p. 518) Joint stiffness.
Property Modes (p. 519) Modes.
Property NastranFilename (p. 519) Full path of Nastran export file.
Property Offset (p. 519) Offset.
Property PyramidElements (p. 519) Pyramid elements.
Property Time (p. 519) Time.
Property WTMass (p. 519) 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 517
Ansys.ACT.Automation.Mechanical Namespace

WTMass(double)
No details are provided for this entry.

JointStiffness(double)
No details are provided for this entry.

PyramidElements(string)
No details are provided for this entry.

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

Time(double)
No details are provided for this entry.

GroundCheck(bool)
No details are provided for this entry.

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
518 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 519
Ansys.ACT.Automation.Mechanical Namespace

NaturalFrequencyConstraint
Defines a NaturalFrequencyConstraint.

Declaration Syntax
public class NaturalFrequencyConstraint : ResponseConstraint

Table 198: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 520)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 520) Gets the internal object. For advanced usage only.
Property MaximumFrequency (p. 520) Gets or sets the MaximumFrequency.
Property MinimumFrequency (p. 521) Gets or sets the MinimumFrequency.
Property ModeNumber (p. 521) Gets or sets the ModeNumber.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
520 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMerge

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 199: Members

Property Children (p. 522) Gets the list of children.


Property Comments (p. 522) Gets the list of associated comments.
Property DataModelObjectCategory (p. 522) Gets the current DataModelObject's category.
Property Figures (p. 522) Gets the list of associated figures.
Property Images (p. 522) Gets the list of associated images.
Property InternalObject (p. 523) Gets the internal object. For advanced usage only.
Property MasterBodies (p. 523) Gets the MasterBodies.
Property MasterLocation (p. 523) Gets or sets the MasterLocation.
Property ScopingMethod (p. 523) No details are provided for this entry.
Property SlaveBodies (p. 523) Gets the SlaveBodies.
Property SlaveLocation (p. 523) Gets or sets the SlaveLocation.
Property Suppressed (p. 524) Gets or sets the Suppressed.
Property ToleranceType (p. 524) Gets or sets the ToleranceType.
Property ToleranceValue (p. 524) Gets/ Sets the ToleranceValue.
Method AddComment() (p. 524) Creates a new child Comment.
Method AddFigure() (p. 524) Creates a new child Figure.
Method AddImage(string) (p. 524) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 521
Ansys.ACT.Automation.Mechanical Namespace

image will be a screen capture of the Geometry


window.
Method Delete() (p. 525) Run the Delete action.
Method Generate() (p. 525) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 525)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 525)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
522 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMerge

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; }

SlaveLocation
Gets or sets the SlaveLocation.

Declaration Syntax
public ISelectionInfo SlaveLocation { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 523
Ansys.ACT.Automation.Mechanical Namespace

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()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
524 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMerge

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 525
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

NodeMergeGroup
Defines a NodeMergeGroup.

Declaration Syntax
public class NodeMergeGroup : ConnectionGroup

Table 200: Members

Property ActiveConnections (p. 2484) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 2483).)


Property AutomaticFixedJoints (p. 2484) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 2483).)


Property Children (p. 2484) Gets the list of children.

(Inherited from ConnectionGroup (p. 2483).)


Property Comments (p. 2485) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 2483).)


Property Connections (p. 2485) Gets the Connections.

(Inherited from ConnectionGroup (p. 2483).)


Property ConnectionType (p. 2485) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 2483).)


Property CylindricalFaces (p. 2485) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 2483).)


Property DataModelObjectCategory (p. 528) Gets the current DataModelObject's category.
Property EdgeEdge (p. 2485) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 2483).)


Property EdgeOverlapTolerance (p. 2486) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceAngleTolerance (p. 2486) Gets or sets the FaceAngleTolerance.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
526 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMergeGroup

(Inherited from ConnectionGroup (p. 2483).)


Property FaceEdge (p. 2486) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceFace (p. 2486) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceFaceDetectionAngleTolerence (p. 2486)Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 2483).)


Property FaceOverlapTolerance (p. 2486) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 2483).)


Property Figures (p. 2487) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 2483).)


Property GroupBy (p. 2487) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 2483).)


Property Images (p. 2487) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 2483).)


Property InternalObject (p. 528) Gets the internal object. For advanced usage
only.
Property Location (p. 2487) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 2483).)


Property MinimumDistancePercentage (p. 2487) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 2483).)


Property MinimumDistanceValue (p. 2488) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 2483).)


Property Priority (p. 2488) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 2483).)


Property RevoluteJoints (p. 2488) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 2483).)


Property SearchAcross (p. 2488) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 2483).)


Property Suppressed (p. 2488) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 2483).)


Property ThicknessScaleFactor (p. 2488) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 2483).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 527
Ansys.ACT.Automation.Mechanical Namespace

Property ToleranceSlider (p. 2489) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceType (p. 2489) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 2483).)


Property ToleranceValue (p. 2489) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 2483).)


Property UseRange (p. 2489) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 2483).)


Method AddNodeMerge() (p. 528) Creates a new NodeMerge
Method GenerateNodeMerge() (p. 528) Run the GenerateNodeMerge 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 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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
528 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMove

NodeMove
Defines a NodeMove.

Declaration Syntax
public class NodeMove : DataModelObject, IReadOnlyList<NodeMoveEntry>, IReadOnlyCollection<No-
deMoveEntry>, IEnumerable<NodeMoveEntry>, IEnumerable, IFolderDataModelObject

Table 201: Members

Property Children (p. 529) Gets the list of children.


Property Comments (p. 530) Gets the list of associated comments.
Property DataModelObjectCategory (p. 530) Gets the current DataModelObject's category.
Property Figures (p. 530) Gets the list of associated figures.
Property Images (p. 530) Gets the list of associated images.
Property Information (p. 530) Gets the Information.
Property InternalObject (p. 530) Gets the internal object. For advanced usage only.
Property NumberOfMoves (p. 531) Gets the NumberOfMoves.
Property NumberOfNodes (p. 531) Gets the NumberOfNodes.
Method AddComment() (p. 531) Creates a new child Comment.
Method AddFigure() (p. 531) Creates a new child Figure.
Method AddImage(string) (p. 531) Creates a new child Image. If a 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. 531) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 532)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 532)
Method MoveNode(int, Quantity, Quantity, Moves a node to a new specified location.
Quantity) (p. 532)
Method UndoAllNodeMoves() (p. 533) Undos all moves done to a node.
Method UndoLastNodeMove() (p. 533) Undos the last move done to a node.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 529
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
530 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMove

NumberOfMoves
Gets the NumberOfMoves.

Declaration Syntax
public uint NumberOfMoves { get; }

NumberOfNodes
Gets the NumberOfNodes.

Declaration Syntax
public uint NumberOfNodes { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 531
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
532 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberingControl

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 202: Members

Property BeginElementNumber (p. 534) Gets or sets the BeginElementNumber.


Property BeginNodeNumber (p. 534) Gets or sets the BeginNodeNumber.
Property Children (p. 534) Gets the list of children.
Property Comments (p. 534) Gets the list of associated comments.
Property DataModelObjectCategory (p. 535) Gets the current DataModelObject's category.
Property EndElementNumber (p. 535) Gets or sets the EndElementNumber.
Property EndNodeNumber (p. 535) Gets or sets the EndNodeNumber.
Property Figures (p. 535) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 533
Ansys.ACT.Automation.Mechanical Namespace

Property Images (p. 535) Gets the list of associated images.


Property InternalObject (p. 535) Gets the internal object. For advanced usage only.
Property Location (p. 536) Gets or sets the Location.
Property NodeNumber (p. 536) Gets or sets the NodeNumber.
Property Suppressed (p. 536) Gets or sets the Suppressed.
Method AddComment() (p. 536) Creates a new child Comment.
Method AddFigure() (p. 536) Creates a new child Figure.
Method AddImage(string) (p. 536) Creates a new child Image. If a 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. 537) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 537)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 537)

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<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
534 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberingControl

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; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 535
Ansys.ACT.Automation.Mechanical Namespace

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()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
536 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberingControl

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 537
Ansys.ACT.Automation.Mechanical Namespace

children(IList<DataModelObject>)
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 203: Members

Property Children (p. 538) Gets the list of children.


Property Comments (p. 538) Gets the list of associated comments.
Property DataModelObjectCategory (p. 539) Gets the current DataModelObject's category.
Property Images (p. 539) Gets the list of associated images.
Property InternalObject (p. 539) Gets the internal object. For advanced usage only.
Property Suppressed (p. 539) Gets or sets the Suppressed.
Property Worksheet (p. 539) Get the ObjectiveWorksheet action.
Method AddComment() (p. 539) Creates a new child Comment.
Method AddImage(string) (p. 540) Creates a new child Image. If a 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. 540) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 540)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 540)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
538 of ANSYS, Inc. and its subsidiaries and affiliates.
Objective

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; }

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 539
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
540 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ObjectiveWorksheet
No details are provided for this entry.

Declaration Syntax
public class ObjectiveWorksheet : Worksheet

Table 204: Members

Property RowCount (p. 542) Deletes a row from the worksheet at index.
Method AddRow() (p. 542) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 542) Deletes a row from the worksheet at index.
Method GetEnabled(int) (p. 542) Gets the worksheet Enabled property at row
index
Method GetEndMode(int) (p. 543) Gets the worksheet End Mode property at index.
Method GetEndStep(int) (p. 543) Gets the worksheet End Step property at index.
Method GetEnvironment(int) (p. 543) Gets the worksheet Environment property at
index.
Method GetFormulation(int) (p. 544) Gets the worksheet Formulation property at
index.
Method GetMode(int) (p. 544) Gets the worksheet Mode property at index.
Method GetMultipleSets(int) (p. 544) Gets the worksheet Multiple Sets property at row
index
Method GetObjectiveType(int) (p. 544) Gets the Objective Type property at index.
Method GetStartMode(int) (p. 545) Gets the worksheet Start Mode property at index.
Method GetStartStep(int) (p. 545) Gets the worksheet Start Step property at index.
Method GetStep(int) (p. 545) Gets the worksheet Step property at index.
Method GetWeight(int) (p. 545) Gets the worksheet Weight property at index.
Method SetEnabled(int, bool) (p. 546) Sets the worksheet Enabled property at row
index.
Method SetEndMode(int, int) (p. 546) Sets the worksheet End Mode property at index.
Method SetEndStep(int, int) (p. 546) Sets the worksheet End Step property at index.
Method SetEnvironment(int, Analysis) (p. 547) Sets the worksheet Environment property at
index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 541
Ansys.ACT.Automation.Mechanical Namespace

Method SetFormulation(int, Sets the worksheet Formulation property at


TopoObjectiveFormulation) (p. 547) index.
Method SetMode(int, int) (p. 547) Sets the worksheet Mode property at index.
Method SetMultipleSets(int, bool) (p. 548) Sets the worksheet Multiple Sets property at row
index.
Method SetObjectiveType(int, Sets the ObjectiveType property at index.
ObjectiveType) (p. 548)
Method SetStartMode(int, int) (p. 548) Sets the worksheet Start Mode property at index.
Method SetStartStep(int, int) (p. 549) Sets the worksheet Start Step property at index.
Method SetStep(int, int) (p. 549) Sets the worksheet Step property at index.
Method SetWeight(int, double) (p. 549) 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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
542 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Declaration Syntax
public bool GetEnabled(int index)

Parameters
index(int)
No details are provided for this entry.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 543
Ansys.ACT.Automation.Mechanical Namespace

GetFormulation(int)
Gets the worksheet Formulation property at index.

Declaration Syntax
public TopoObjectiveFormulation GetFormulation(int index)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
544 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Parameters
index(int)
No details are provided for this entry.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 545
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double GetWeight(int index)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
546 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.

Declaration Syntax
public void SetMode(int index, int newVal)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 547
Ansys.ACT.Automation.Mechanical Namespace

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.

SetStartMode(int, int)
Sets the worksheet Start Mode property at index.

Declaration Syntax
public void SetStartMode(int index, int newVal)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
548 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.

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.

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 549
Ansys.ACT.Automation.Mechanical Namespace

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 205: Members

Property BoundaryCondition (p. 550) Gets or sets the BoundaryCondition.


Property Children (p. 553) Gets the list of children.

(Inherited from
OptimizationRegionBaseClass (p. 552).)
Property DataModelObjectCategory (p. 550) Gets the current DataModelObject's category.
Property DesignRegionLocation (p. 551) Gets or sets the DesignRegionLocation.
Property ExclusionRegionLocation (p. 551) Gets or sets the ExclusionRegionLocation.
Property InternalObject (p. 551) Gets the internal object. For advanced usage
only.
Property LatticeMaxDensity (p. 551) Gets or sets the LatticeMaxDensity.
Property LatticeMinDensity (p. 551) Gets or sets the LatticeMinDensity.
Property LatticeSize (p. 551) Gets or sets the LatticeSize.
Property LatticeType (p. 552) Gets or sets the LatticeType.
Property OptimizationType (p. 552) Gets or sets the OptimizationType.
Method AddExclusionRegion() (p. 552) Creates a new ExclusionRegion

BoundaryCondition
Gets or sets the BoundaryCondition.

Declaration Syntax
public BoundaryConditionType BoundaryCondition { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
550 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegion

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DesignRegionLocation
Gets or sets the DesignRegionLocation.

Declaration Syntax
public ISelectionInfo DesignRegionLocation { set;get; }

ExclusionRegionLocation
Gets or sets the ExclusionRegionLocation.

Declaration Syntax
public ISelectionInfo ExclusionRegionLocation { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSOptimizationRegionAuto InternalObject { get; }

LatticeMaxDensity
Gets or sets the LatticeMaxDensity.

Declaration Syntax
public double LatticeMaxDensity { set;get; }

LatticeMinDensity
Gets or sets the LatticeMinDensity.

Declaration Syntax
public double LatticeMinDensity { set;get; }

LatticeSize
Gets or sets the LatticeSize.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 551
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity LatticeSize { set;get; }

LatticeType
Gets or sets the LatticeType.

Declaration Syntax
public LatticeType LatticeType { set;get; }

OptimizationType
Gets or sets the OptimizationType.

Declaration Syntax
public OptimizationType OptimizationType { set;get; }

AddExclusionRegion()
Creates a new ExclusionRegion

Declaration Syntax
public virtual ExclusionRegion AddExclusionRegion()

OptimizationRegionBaseClass
Defines a OptimizationRegionBaseClass.

Declaration Syntax
public abstract class OptimizationRegionBaseClass : DataModelObject

Table 206: Members

Property Children (p. 553) Gets the list of children.


Property InternalObject (p. 553) Gets the internal object. For advanced
usage only.
Method Delete() (p. 553) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 553)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 553)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
552 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegionBaseClass

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 553
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Part
Defines a Part.

Declaration Syntax
public class Part : DataModelObject, IFolderDataModelObject

Table 207: Members

Property ApproximateSurfaceArea (p. 555) Gets the ApproximateSurfaceArea.


Property Assignment ***OBSOLETE*** Use Gets or sets the Assignment.
'Material' property instead. (p. 555)
Property Average (p. 556) Gets the Average.
Property CentroidX (p. 556) Gets the CentroidX.
Property CentroidY (p. 556) Gets the CentroidY.
Property CentroidZ (p. 556) Gets the CentroidZ.
Property Children (p. 556) Gets the list of children.
Property Comments (p. 556) Gets the list of associated comments.
Property CoordinateSystem (p. 557) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 557) Gets the current DataModelObject's category.
Property Elements (p. 557) Gets the Elements.
Property Figures (p. 557) Gets the list of associated figures.
Property Hidden (p. 557) Hide or show the body.
Property Images (p. 557) Gets the list of associated images.
Property InternalObject (p. 558) Gets the internal object. For advanced usage only.
Property LengthX (p. 558) Gets the LengthX.
Property LengthY (p. 558) Gets the LengthY.
Property LengthZ (p. 558) Gets the LengthZ.
Property Mass (p. 558) Gets the Mass.
Property Material (p. 558) Gets or sets the Material.
Property MaterialName ***OBSOLETE*** Use Gets or sets the MaterialName.
'Assignment' property instead. (p. 559)
Property Maximum (p. 559) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
554 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

Property MeshMetric (p. 559) Gets the MeshMetric.


Property Minimum (p. 559) Gets the Minimum.
Property MomentOfInertiaIp1 (p. 559) Gets the MomentOfInertiaIp1.
Property MomentOfInertiaIp2 (p. 559) Gets the MomentOfInertiaIp2.
Property MomentOfInertiaIp3 (p. 560) Gets the MomentOfInertiaIp3.
Property Nodes (p. 560) Gets the Nodes.
Property StandardDeviation (p. 560) Gets the StandardDeviation.
Property Suppressed (p. 560) Gets or sets the Suppressed.
Property Visible (p. 560) Gets or sets the Visible.
Property Volume (p. 560) Gets the Volume.
Method AddComment() (p. 561) Creates a new child Comment.
Method AddFigure() (p. 561) Creates a new child Figure.
Method AddImage(string) (p. 561) Creates a new child Image. If a 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. 561) Run the ClearGeneratedData action.
Method GenerateMesh() (p. 561) Run the GenerateMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 561)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 562)
Method PreviewInflation() (p. 562) Run the PreviewInflation action.
Method PreviewSurfaceMesh() (p. 562) Run the PreviewSurfaceMesh action.
Method Update() (p. 563) 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 555
Ansys.ACT.Automation.Mechanical Namespace

Average
Gets the Average.

Declaration Syntax
public double Average { get; }

CentroidX
Gets the CentroidX.

Declaration Syntax
public Quantity CentroidX { get; }

CentroidY
Gets the CentroidY.

Declaration Syntax
public Quantity CentroidY { get; }

CentroidZ
Gets the CentroidZ.

Declaration Syntax
public Quantity CentroidZ { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
556 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Elements
Gets the Elements.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 557
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSBodyGroupAuto InternalObject { get; }

LengthX
Gets the LengthX.

Declaration Syntax
public Quantity LengthX { get; }

LengthY
Gets the LengthY.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
558 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

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


Gets or sets the MaterialName.

Declaration Syntax
public string MaterialName { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

MeshMetric
Gets the MeshMetric.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 559
Ansys.ACT.Automation.Mechanical Namespace

MomentOfInertiaIp3
Gets the MomentOfInertiaIp3.

Declaration Syntax
public Quantity MomentOfInertiaIp3 { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public double StandardDeviation { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Visible
Gets or sets the Visible.

Declaration Syntax
public bool Visible { set;get; }

Volume
Gets the Volume.

Declaration Syntax
public Quantity Volume { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
560 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

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.

Declaration Syntax
public virtual void GenerateMesh()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 561
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

PreviewInflation()
Run the PreviewInflation action.

Declaration Syntax
public virtual void PreviewInflation()

PreviewSurfaceMesh()
Run the PreviewSurfaceMesh action.

Declaration Syntax
public virtual void PreviewSurfaceMesh()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
562 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransform

Update()
Run the Update action.

Declaration Syntax
public virtual void Update()

PartTransform
Defines a PartTransform.

Declaration Syntax
public class PartTransform : DataModelObject, IFolderDataModelObject

Table 208: Members

Property Children (p. 564) Gets the list of children.


Property Comments (p. 564) Gets the list of associated comments.
Property CoordinateSystem (p. 564) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 564) Gets the current DataModelObject's category.
Property DefineBy (p. 564) Gets or sets the DefineBy.
Property Figures (p. 565) Gets the list of associated figures.
Property Images (p. 565) Gets the list of associated images.
Property InternalObject (p. 565) Gets the internal object. For advanced usage only.
Property Location (p. 565) Gets or sets the Location.
Property Parts (p. 565) Gets or sets the OutlineSelection.
Property RotationX (p. 565) Gets or sets the RotationX.
Property RotationY (p. 566) Gets or sets the RotationY.
Property RotationZ (p. 566) Gets or sets the RotationZ.
Property ScopingMethod (p. 566) Gets or sets the ScopingMethod.
Property SourceCoordinateSystem (p. 566) Gets or sets the SourceCoordinateSystem.
Property Suppressed (p. 566) Gets or sets the Suppressed.
Property TargetCoordinateSystem (p. 566) Gets or sets the TargetCoordinateSystem.
Property TranslationX (p. 567) Gets or sets the TranslationX.
Property TranslationY (p. 567) Gets or sets the TranslationY.
Property TranslationZ (p. 567) Gets or sets the TranslationZ.
Method AddComment() (p. 567) Creates a new child Comment.
Method AddFigure() (p. 567) Creates a new child Figure.
Method AddImage(string) (p. 567) Creates a new child Image. If a 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 563
Ansys.ACT.Automation.Mechanical Namespace

Method Delete() (p. 568) Run the Delete action.


Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 568)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 568)
Method TransformGeometry() (p. 569) No details are provided for this entry.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineBy
Gets or sets the DefineBy.

Declaration Syntax
public PartTransformationDefinitionType DefineBy { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
564 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransform

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; }

Parts
Gets or sets the OutlineSelection.

Declaration Syntax
public IEnumerable<DataModelObject> Parts { set;get; }

RotationX
Gets or sets the RotationX.

Declaration Syntax
public Quantity RotationX { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 565
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public CoordinateSystem TargetCoordinateSystem { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
566 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransform

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.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 567
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
568 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransformGroup

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 209: Members

Property Children (p. 569) Gets the list of children.


Property Comments (p. 570) Gets the list of associated comments.
Property DataModelObjectCategory (p. 570) Gets the current DataModelObject's category.
Property Figures (p. 570) Gets the list of associated figures.
Property Images (p. 570) Gets the list of associated images.
Property InternalObject (p. 570) Gets the internal object. For advanced usage only.
Property RegenerateContacts (p. 570) Gets or sets the RegenerateContacts.
Property Suppressed (p. 571) Gets or sets the Suppressed.
Property TransformMesh (p. 571) Gets or sets the TransformMesh.
Method AddComment() (p. 571) Creates a new child Comment.
Method AddFigure() (p. 571) Creates a new child Figure.
Method AddImage(string) (p. 571) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddPartTransform() (p. 572) Creates a new PartTransform
Method Delete() (p. 572) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 572)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 572)
Method TransformGeometry() (p. 573) No details are provided for this entry.

Children
Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 569
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IList<DataModelObject> 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 IDSPartTransformGroupAuto InternalObject { get; }

RegenerateContacts
Gets or sets the RegenerateContacts.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
570 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransformGroup

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.

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 571
Ansys.ACT.Automation.Mechanical Namespace

AddPartTransform()
Creates a new PartTransform

Declaration Syntax
public virtual PartTransform AddPartTransform()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
572 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

children(IList<DataModelObject>)
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 210: Members

Property Children (p. 574) Gets the list of children.


Property Comments (p. 574) Gets the list of associated comments.
Property DataModelObjectCategory (p. 574) Gets the current DataModelObject's category.
Property EndCoordinateSystem (p. 574) Gets or sets the EndCoordinateSystem.
Property EndXCoordinate (p. 574) Gets or sets the EndXCoordinate.
Property EndYCoordinate (p. 575) Gets or sets the EndYCoordinate.
Property EndZCoordinate (p. 575) Gets or sets the EndZCoordinate.
Property Figures (p. 575) Gets the list of associated figures.
Property HasValidGeometrySelection (p. 575) Gets the HasValidGeometrySelection.
Property Images (p. 575) Gets the list of associated images.
Property InternalObject (p. 575) Gets the internal object. For advanced usage only.
Property Location (p. 576) Gets or sets the Location.
Property NumberOfSamplingPoints (p. 576) Gets or sets the NumberOfSamplingPoints.
Property PathCoordinateSystem (p. 576) Gets or sets the PathCoordinateSystem.
Property PathType (p. 576) Gets or sets the PathType.
Property ShowMesh (p. 576) Gets or sets the ShowMesh.
Property SnapToMeshNodes (p. 576) Gets or sets the SnapToMeshNodes.
Property StartCoordinateSystem (p. 577) Gets or sets the StartCoordinateSystem.
Property StartXCoordinate (p. 577) Gets or sets the StartXCoordinate.
Property StartYCoordinate (p. 577) Gets or sets the StartYCoordinate.
Property StartZCoordinate (p. 577) Gets or sets the StartZCoordinate.
Property Suppressed (p. 577) Gets or sets the Suppressed.
Method AddComment() (p. 577) Creates a new child Comment.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 573
Ansys.ACT.Automation.Mechanical Namespace

Method AddFigure() (p. 578) Creates a new child Figure.


Method AddImage(string) (p. 578) Creates a new child Image. If a 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. 578) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 578)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 579)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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; }

EndCoordinateSystem
Gets or sets the EndCoordinateSystem.

Declaration Syntax
public CoordinateSystem EndCoordinateSystem { set;get; }

EndXCoordinate
Gets or sets the EndXCoordinate.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
574 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

Declaration Syntax
public Quantity EndXCoordinate { set;get; }

EndYCoordinate
Gets or sets the EndYCoordinate.

Declaration Syntax
public Quantity EndYCoordinate { set;get; }

EndZCoordinate
Gets or sets the EndZCoordinate.

Declaration Syntax
public Quantity EndZCoordinate { set;get; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 575
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSPathAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NumberOfSamplingPoints
Gets or sets the NumberOfSamplingPoints.

Declaration Syntax
public int NumberOfSamplingPoints { set;get; }

PathCoordinateSystem
Gets or sets the PathCoordinateSystem.

Declaration Syntax
public CoordinateSystem PathCoordinateSystem { set;get; }

PathType
Gets or sets the PathType.

Declaration Syntax
public PathScopingType PathType { set;get; }

ShowMesh
Gets or sets the ShowMesh.

Declaration Syntax
public bool ShowMesh { set;get; }

SnapToMeshNodes
Gets or sets the SnapToMeshNodes.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
576 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

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.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 577
Ansys.ACT.Automation.Mechanical Namespace

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.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
578 of ANSYS, Inc. and its subsidiaries and affiliates.
PeriodicRegion

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

PeriodicRegion
Defines a PeriodicRegion.

Declaration Syntax
public class PeriodicRegion : SymmetryGeneral

Table 211: Members

Property Children (p. 783) Gets the list of children.

(Inherited from SymmetryGeneral (p. 782).)


Property Comments (p. 783) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 782).)


Property CoordinateSystem (p. 784) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 782).)


Property DataModelObjectCategory (p. 580)Gets the current DataModelObject's
category.
Property Figures (p. 784) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 782).)


Property HighBoundaryLocation (p. 784) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property Images (p. 784) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 782).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 579
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 580) Gets the internal object. For advanced usage
only.
Property Location (p. 785) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 782).)


Property LowBoundaryLocation (p. 785) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property ScopeMode (p. 785) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 782).)


Property Suppressed (p. 785) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 782).)


Property Type (p. 580) Gets or sets the Type.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

Type
Gets or sets the Type.

Declaration Syntax
public PeriodicRegionType Type { set;get; }

PhysicsRegion
Defines a PhysicsRegion.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
580 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Declaration Syntax
public class PhysicsRegion : DataModelObject, IFolderDataModelObject

Table 212: Members

Property Acoustics (p. 582) Gets or sets the Acoustics.


Property ArtificiallyMatchedLayers (p. 582) Gets or sets the ArtificiallyMatchedLayers.
Property Children (p. 582) Gets the list of children.
Property DataModelObjectCategory (p. 582) Gets the current DataModelObject's
category.
Property ElementMorphing (p. 582) Gets or sets the ElementMorphing.
Property EvanescentWaveAttenuation (p. 582) Gets or sets the
EvanescentWaveAttenuation.
Property FluidBehavior (p. 583) Gets or sets the FluidBehavior.
Property InternalObject (p. 583) Gets the internal object. For advanced
usage only.
Property Location (p. 583) Gets or sets the Location.
Property PMLElementCoordinateSystem (p. 583) Gets or sets the
PMLElementCoordinateSystem.
Property PMLOptions (p. 583) Gets or sets the PMLOptions.
Property ReferencePressure (p. 583) Gets or sets the ReferencePressure.
Property ReferenceStaticPressure (p. 584) Gets or sets the ReferenceStaticPressure.
Property ReflectionCoefficient (p. 584) Gets or sets the ReflectionCoefficient.
Property ReflectionCoefficientInNegativeXDirection (p. 584) Gets or sets the
ReflectionCoefficientInNegativeXDirection.
Property ReflectionCoefficientInNegativeYDirection (p. 584) Gets or sets the
ReflectionCoefficientInNegativeYDirection.
Property ReflectionCoefficientInNegativeZDirection (p. 584) Gets or sets the
ReflectionCoefficientInNegativeZDirection.
Property ReflectionCoefficientInPositiveXDirection (p. 584) Gets or sets the
ReflectionCoefficientInPositiveXDirection.
Property ReflectionCoefficientInPositiveYDirection (p. 585) Gets or sets the
ReflectionCoefficientInPositiveYDirection.
Property ReflectionCoefficientInPositiveZDirection (p. 585) Gets or sets the
ReflectionCoefficientInPositiveZDirection.
Property ReflectionCoefficientsType (p. 585) Gets or sets the
ReflectionCoefficientsType.
Property Structural (p. 585) Gets or sets the Structural.
Property Suppressed (p. 585) Gets or sets the Suppressed.
Property Thermal (p. 585) Gets or sets the Thermal.
Property ThermalStrain (p. 586) Gets or sets the ThermalStrain.
Property ThermoelasticDamping (p. 586) Gets or sets the ThermoelasticDamping.
Method Delete() (p. 586) Run the Delete action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 581
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.


IList<ChildrenType>) (p. 586)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 586)

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; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementMorphing
Gets or sets the ElementMorphing.

Declaration Syntax
public ElementMorphingType ElementMorphing { set;get; }

EvanescentWaveAttenuation
Gets or sets the EvanescentWaveAttenuation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
582 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Declaration Syntax
public bool EvanescentWaveAttenuation { set;get; }

FluidBehavior
Gets or sets the FluidBehavior.

Declaration Syntax
public FluidBehavior FluidBehavior { set;get; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 583
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity ReferencePressure { set;get; }

ReferenceStaticPressure
Gets or sets the ReferenceStaticPressure.

Declaration Syntax
public Quantity ReferenceStaticPressure { set;get; }

ReflectionCoefficient
Gets or sets the ReflectionCoefficient.

Declaration Syntax
public double ReflectionCoefficient { set;get; }

ReflectionCoefficientInNegativeXDirection
Gets or sets the ReflectionCoefficientInNegativeXDirection.

Declaration Syntax
public double ReflectionCoefficientInNegativeXDirection { set;get; }

ReflectionCoefficientInNegativeYDirection
Gets or sets the ReflectionCoefficientInNegativeYDirection.

Declaration Syntax
public double ReflectionCoefficientInNegativeYDirection { set;get; }

ReflectionCoefficientInNegativeZDirection
Gets or sets the ReflectionCoefficientInNegativeZDirection.

Declaration Syntax
public double ReflectionCoefficientInNegativeZDirection { set;get; }

ReflectionCoefficientInPositiveXDirection
Gets or sets the ReflectionCoefficientInPositiveXDirection.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
584 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Declaration Syntax
public double ReflectionCoefficientInPositiveXDirection { set;get; }

ReflectionCoefficientInPositiveYDirection
Gets or sets the ReflectionCoefficientInPositiveYDirection.

Declaration Syntax
public double ReflectionCoefficientInPositiveYDirection { set;get; }

ReflectionCoefficientInPositiveZDirection
Gets or sets the ReflectionCoefficientInPositiveZDirection.

Declaration Syntax
public double ReflectionCoefficientInPositiveZDirection { set;get; }

ReflectionCoefficientsType
Gets or sets the ReflectionCoefficientsType.

Declaration Syntax
public ReflectionCoefficientsType ReflectionCoefficientsType { set;get; }

Structural
Gets or sets the Structural.

Declaration Syntax
public bool Structural { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Thermal
Gets or sets the Thermal.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 585
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Thermal { set;get; }

ThermalStrain
Gets or sets the ThermalStrain.

Declaration Syntax
public ThermalStrainType ThermalStrain { set;get; }

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<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
586 of ANSYS, Inc. and its subsidiaries and affiliates.
PipeIdealization

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

PipeIdealization
Defines a PipeIdealization.

Declaration Syntax
public class PipeIdealization : DataModelObject, IFolderDataModelObject

Table 213: Members

Property Children (p. 587) Gets the list of children.


Property DataModelObjectCategory (p. 588) Gets the current DataModelObject's
category.
Property Extend (p. 588) Gets or sets the Extend.
Property Factor (p. 588) Gets or sets the Factor.
Property GeometrySelection (p. 588) Gets or sets the GeometrySelection.
Property InternalObject (p. 588) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 588) Gets or sets the Suppressed.
Method Delete() (p. 589) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 589)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 589)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 587
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Extend
Gets or sets the Extend.

Declaration Syntax
public GrowElbowElementsBy Extend { set;get; }

Factor
Gets or sets the Factor.

Declaration Syntax
public double Factor { set;get; }

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPipeIdealizationAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
588 of ANSYS, Inc. and its subsidiaries and affiliates.
PointMass

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

PointMass
Defines a PointMass.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 589
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class PointMass : GenericPointMass

Table 214: Members

Property AppliedBy (p. 591) Gets or sets the AppliedBy.


Property BeamRadius (p. 591) Gets or sets the BeamRadius.
Property Behavior (p. 591) Gets or sets the Behavior.
Property Children (p. 354) Gets the list of children.

(Inherited from GenericPointMass (p. 353).)


Property Comments (p. 354) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 353).)


Property CoordinateSystem (p. 591) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 591) Gets the current DataModelObject's category.
Property Figures (p. 355) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 353).)


Property Images (p. 355) Gets the list of associated images.

(Inherited from GenericPointMass (p. 353).)


Property InternalObject (p. 591) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 355) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 353).)


Property Location (p. 355) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 353).)


Property Mass (p. 592) Gets or sets the Mass.
Property MassMomentOfInertiaX (p. 592) Gets or sets the MassMomentOfInertiaX.
Property MassMomentOfInertiaY (p. 592) Gets or sets the MassMomentOfInertiaY.
Property MassMomentOfInertiaZ (p. 592) Gets or sets the MassMomentOfInertiaZ.
Property Material (p. 592) Gets or sets the Material.
Property NodalCoordinateSystem (p. 592) Gets the NodalCoordinateSystem.
Property PinballRegion (p. 593) Gets or sets the PinballRegion.
Property RemotePoint (p. 355) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 353).)


Property Suppressed (p. 593) Gets or sets the Suppressed.
Property XCoordinate (p. 593) Gets or sets the XCoordinate.
Property YCoordinate (p. 593) Gets or sets the YCoordinate.
Property ZCoordinate (p. 593) Gets or sets the ZCoordinate.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
590 of ANSYS, Inc. and its subsidiaries and affiliates.
PointMass

Method PromoteToRemotePoint() (p. 593) Run the PromoteToRemotePoint action.

AppliedBy
Gets or sets the AppliedBy.

Declaration Syntax
public RemoteApplicationType AppliedBy { set;get; }

BeamRadius
Gets or sets the BeamRadius.

Declaration Syntax
public Quantity BeamRadius { set;get; }

Behavior
Gets or sets the Behavior.

Declaration Syntax
public LoadBehavior Behavior { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 591
Ansys.ACT.Automation.Mechanical Namespace

Mass
Gets or sets the Mass.

Declaration Syntax
public Quantity Mass { set;get; }

MassMomentOfInertiaX
Gets or sets the MassMomentOfInertiaX.

Declaration Syntax
public Quantity MassMomentOfInertiaX { set;get; }

MassMomentOfInertiaY
Gets or sets the MassMomentOfInertiaY.

Declaration Syntax
public Quantity MassMomentOfInertiaY { set;get; }

MassMomentOfInertiaZ
Gets or sets the MassMomentOfInertiaZ.

Declaration Syntax
public Quantity MassMomentOfInertiaZ { set;get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

NodalCoordinateSystem
Gets the NodalCoordinateSystem.

Declaration Syntax
public CoordinateSystem NodalCoordinateSystem { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
592 of ANSYS, Inc. and its subsidiaries and affiliates.
PointMass

PinballRegion
Gets or sets the PinballRegion.

Declaration Syntax
public Quantity PinballRegion { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

XCoordinate
Gets or sets the XCoordinate.

Declaration Syntax
public Quantity XCoordinate { set;get; }

YCoordinate
Gets or sets the YCoordinate.

Declaration Syntax
public Quantity YCoordinate { set;get; }

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 593
Ansys.ACT.Automation.Mechanical Namespace

PostContactTool
Defines a PostContactTool.

Declaration Syntax
public class PostContactTool : PreContactTool

Table 215: Members

Property Children (p. 2521) Gets the list of children.

(Inherited from ContactTool (p. 2521).)


Property Comments (p. 2522) Gets the list of associated comments.

(Inherited from ContactTool (p. 2521).)


Property DataModelObjectCategory (p. 594)Gets the current DataModelObject's
category.
Property Figures (p. 2522) Gets the list of associated figures.

(Inherited from ContactTool (p. 2521).)


Property Images (p. 2522) Gets the list of associated images.

(Inherited from ContactTool (p. 2521).)


Property InternalObject (p. 595) Gets the internal object. For advanced usage
only.
Property Location (p. 2522) Gets or sets the Location.

(Inherited from ContactTool (p. 2521).)


Property ScopingMethod (p. 2523) Gets or sets the ScopingMethod.

(Inherited from ContactTool (p. 2521).)


Method AddFluidPressure() (p. 595) Creates a new ContactFluidPressure
Method AddFrictionalStress() (p. 595) Creates a new ContactFrictionalStress
Method AddHeatFlux() (p. 595) Creates a new ContactHeatFlux
Method AddPressure() (p. 595) Creates a new ContactPressure
Method AddSlidingDistance() (p. 595) Creates a new ContactSlidingDistance

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
594 of ANSYS, Inc. and its subsidiaries and affiliates.
PostContactTool

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSContactToolAuto InternalObject { get; }

AddFluidPressure()
Creates a new ContactFluidPressure

Declaration Syntax
public virtual ContactFluidPressure AddFluidPressure()

AddFrictionalStress()
Creates a new ContactFrictionalStress

Declaration Syntax
public virtual ContactFrictionalStress AddFrictionalStress()

AddHeatFlux()
Creates a new ContactHeatFlux

Declaration Syntax
public virtual ContactHeatFlux AddHeatFlux()

AddPressure()
Creates a new ContactPressure

Declaration Syntax
public virtual ContactPressure AddPressure()

AddSlidingDistance()
Creates a new ContactSlidingDistance

Declaration Syntax
public virtual ContactSlidingDistance AddSlidingDistance()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 595
Ansys.ACT.Automation.Mechanical Namespace

PreContactTool
Defines a PreContactTool.

Declaration Syntax
public class PreContactTool : ContactTool

Table 216: Members

Property Children (p. 2521) Gets the list of children.

(Inherited from ContactTool (p. 2521).)


Property Comments (p. 2522) Gets the list of associated comments.

(Inherited from ContactTool (p. 2521).)


Property DataModelObjectCategory (p. 596)Gets the current DataModelObject's
category.
Property Figures (p. 2522) Gets the list of associated figures.

(Inherited from ContactTool (p. 2521).)


Property Images (p. 2522) Gets the list of associated images.

(Inherited from ContactTool (p. 2521).)


Property InternalObject (p. 596) Gets the internal object. For advanced usage
only.
Property Location (p. 2522) Gets or sets the Location.

(Inherited from ContactTool (p. 2521).)


Property ScopingMethod (p. 2523) Gets or sets the ScopingMethod.

(Inherited from ContactTool (p. 2521).)


Method AddGap() (p. 597) Creates a new ContactGap
Method AddInitialInformation() (p. 597) Creates a new ContactDataTable
Method AddPenetration() (p. 597) Creates a new ContactPenetration
Method AddStatus() (p. 597) 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
596 of ANSYS, Inc. and its subsidiaries and affiliates.
PreMeshedCrack

Declaration Syntax
public IDSContactToolAuto InternalObject { get; }

AddGap()
Creates a new ContactGap

Declaration Syntax
public virtual ContactGap AddGap()

AddInitialInformation()
Creates a new ContactDataTable

Declaration Syntax
public virtual ContactDataTable AddInitialInformation()

AddPenetration()
Creates a new ContactPenetration

Declaration Syntax
public virtual ContactPenetration AddPenetration()

AddStatus()
Creates a new ContactStatus

Declaration Syntax
public virtual ContactStatus AddStatus()

PreMeshedCrack
Defines a PreMeshedCrack.

Declaration Syntax
public class PreMeshedCrack : GenericCrack

Table 217: Members

Property BottomFaceNodes (p. 598) Gets or sets the BottomFaceNodes.


Property Children (p. 347) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 597
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from GenericCrack (p. 347).)


Property Comments (p. 348) Gets the list of associated comments.

(Inherited from GenericCrack (p. 347).)


Property CoordinateSystem (p. 598) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 598) Gets or sets the CrackFacesNodes.
Property CrackFront (p. 599) Gets or sets the CrackFront.
Property CrackSourceType (p. 599) Gets the CrackSourceType.
Property CrackSymmetry (p. 599) Gets or sets the CrackSymmetry.
Property DataModelObjectCategory (p. 599) Gets the current DataModelObject's
category.
Property Figures (p. 348) Gets the list of associated figures.

(Inherited from GenericCrack (p. 347).)


Property Images (p. 348) Gets the list of associated images.

(Inherited from GenericCrack (p. 347).)


Property InternalObject (p. 599) Gets the internal object. For advanced usage
only.
Property ScopingMethod (p. 599) Gets the ScopingMethod.
Property SolutionContours (p. 600) Gets or sets the SolutionContours.
Property Suppressed (p. 600) Gets or sets the Suppressed.
Property TopFaceNodes (p. 600) 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
598 of ANSYS, Inc. and its subsidiaries and affiliates.
PreMeshedCrack

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFront
Gets or sets the CrackFront.

Declaration Syntax
public NamedSelection CrackFront { set;get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

CrackSymmetry
Gets or sets the CrackSymmetry.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 599
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public NamedSelection TopFaceNodes { set;get; }

PreMeshedCyclicRegion
Defines a PreMeshedCyclicRegion.

Declaration Syntax
public class PreMeshedCyclicRegion : SymmetryGeneral

Table 218: Members

Property BoundaryDOFOrientation (p. 601) Gets or sets the BoundaryDOFOrientation.


Property Children (p. 783) Gets the list of children.

(Inherited from SymmetryGeneral (p. 782).)


Property Comments (p. 783) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 782).)


Property CoordinateSystem (p. 784) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 782).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
600 of ANSYS, Inc. and its subsidiaries and affiliates.
PreMeshedCyclicRegion

Property DataModelObjectCategory (p. 601)Gets the current DataModelObject's


category.
Property Figures (p. 784) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 782).)


Property HighBoundaryLocation (p. 784) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property Images (p. 784) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 782).)


Property InternalObject (p. 601) Gets the internal object. For advanced usage
only.
Property Location (p. 785) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 782).)


Property LowBoundaryLocation (p. 785) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property NumberOfSectors (p. 602) Gets or sets the NumberOfSectors.
Property RelativeDistanceTolerance (p. 602) Gets or sets the RelativeDistanceTolerance.
Property ScopeMode (p. 785) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 782).)


Property Suppressed (p. 785) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 782).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 601
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

NumberOfSectors
Gets or sets the NumberOfSectors.

Declaration Syntax
public int NumberOfSectors { set;get; }

RelativeDistanceTolerance
Gets or sets the RelativeDistanceTolerance.

Declaration Syntax
public double RelativeDistanceTolerance { set;get; }

PrimaryCriterion
Defines a PrimaryCriterion.

Declaration Syntax
public class PrimaryCriterion : Criterion

Table 219: Members

Property BaseResult (p. 603) Gets or sets the BaseResult.


Property Children (p. 283) Gets the list of children.

(Inherited from Criterion (p. 282).)


Property Comments (p. 283) Gets the list of associated comments.

(Inherited from Criterion (p. 282).)


Property DataModelObjectCategory (p. 603)Gets the current DataModelObject's
category.
Property Figures (p. 283) Gets the list of associated figures.

(Inherited from Criterion (p. 282).)


Property Images (p. 284) Gets the list of associated images.

(Inherited from Criterion (p. 282).)


Property InternalObject (p. 603) Gets the internal object. For advanced usage
only.
Property Location (p. 603) Gets or sets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
602 of ANSYS, Inc. and its subsidiaries and affiliates.
PrimaryCriterion

Property ReferenceType (p. 604) Gets or sets the ReferenceType.


Property SpatialReduction (p. 604) Gets or sets the SpatialReduction.
Property SpatialReductionMethod (p. 604) Gets or sets the SpatialReductionMethod.
Property Step (p. 604) Gets or sets the Step.
Property Suppressed (p. 284) Gets or sets the Suppressed.

(Inherited from Criterion (p. 282).)


Property Value (p. 284) Gets the Value.

(Inherited from Criterion (p. 282).)


Property VectorReduction (p. 604) Gets or sets the VectorReduction.
Method ClearGeneratedData() (p. 604) Run the ClearGeneratedData action.
Method EvaluateAllResults() (p. 605) Run the EvaluateAllResults action.

BaseResult
Gets or sets the BaseResult.

Declaration Syntax
public BaseResultType BaseResult { 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 IDSTopoCriterionAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 603
Ansys.ACT.Automation.Mechanical Namespace

ReferenceType
Gets or sets the ReferenceType.

Declaration Syntax
public VectorReductionReferenceType ReferenceType { 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; }

VectorReduction
Gets or sets the VectorReduction.

Declaration Syntax
public VectorReductionType VectorReduction { set;get; }

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
604 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

Project
Defines a Project.

Declaration Syntax
public class Project : DataModelObject, IFolderDataModelObject

Table 220: Members

Property Author (p. 606) Gets or sets the Author.


Property Children (p. 606) Gets the list of children.
Property Comments (p. 606) Gets the list of associated comments.
Property CreationDate (p. 606) Gets the CreationDate.
Property CreationTime (p. 606) Gets the CreationTime.
Property DataModelObjectCategory (p. 607) Gets the current DataModelObject's category.
Property FirstSaved (p. 607) Gets the FirstSaved.
Property Images (p. 607) Gets the list of associated images.
Property ImportedSource (p. 607) Gets the ImportedSource.
Property ImportedVersion (p. 607) Gets the ImportedVersion.
Property InternalObject (p. 607) Gets the internal object. For advanced usage
only.
Property LastSaved (p. 608) Gets the LastSaved.
Property Model (p. 608) Gets the Model.
Property Models ***OBSOLETE*** Use 'Model' Gets the Model.
property instead. (p. 608)
Property PreparedFor (p. 608) Gets or sets the PreparedFor.
Property ProductVersion (p. 608) Gets the ProductVersion.
Property SaveProjectAfterSolution (p. 608) Gets or sets the SaveProjectAfterSolution.
Property SaveProjectBeforeSolution (p. 609) Gets or sets the SaveProjectBeforeSolution.
Property Subject (p. 609) Gets or sets the Subject.
Property UnitSystem (p. 609) Change the Unit System.
Method AddComment() (p. 609) Creates a new child Comment.
Method AddImage(string) (p. 609) Creates a new child Image. If a filePath is
provided, the image will be loaded from that

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 605
Ansys.ACT.Automation.Mechanical Namespace

file, if not, the image will be a screen capture


of the Geometry window.
Method ClearGeneratedData() (p. 610) Run the ClearGeneratedData action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 610)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 610)
Method SpecifyMetricTemperatureInCelsius() (p. 610) Specify the use of Celsius thermal units for
metric unit systems.
Method SpecifyMetricTemperatureInKelvin() (p. 611) Specify the use of Kelvin thermal units for
metric unit systems.

Author
Gets or sets the Author.

Declaration Syntax
public string Author { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
606 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

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; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 607
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSProjectAuto InternalObject { get; }

LastSaved
Gets the LastSaved.

Declaration Syntax
public string LastSaved { get; }

Model
Gets the Model.

Declaration Syntax
public Model Model { get; }

Models ***OBSOLETE*** Use 'Model' property instead.


Gets the Model.

Declaration Syntax
public IEnumerable<Model> Models { get; }

PreparedFor
Gets or sets the PreparedFor.

Declaration Syntax
public string PreparedFor { set;get; }

ProductVersion
Gets the ProductVersion.

Declaration Syntax
public string ProductVersion { get; }

SaveProjectAfterSolution
Gets or sets the SaveProjectAfterSolution.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
608 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

Declaration Syntax
public bool SaveProjectAfterSolution { set;get; }

SaveProjectBeforeSolution
Gets or sets the SaveProjectBeforeSolution.

Declaration Syntax
public bool SaveProjectBeforeSolution { set;get; }

Subject
Gets or sets the Subject.

Declaration Syntax
public string Subject { set;get; }

UnitSystem
Change the Unit System.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 609
Ansys.ACT.Automation.Mechanical Namespace

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
610 of ANSYS, Inc. and its subsidiaries and affiliates.
PullOutDirectionManufacturingConstraint

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 221: Members

Property Axis (p. 611) Gets or sets the Axis.


Property Children (p. 436) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 435).)
Property CoordinateSystem (p. 612) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 612)Gets the current DataModelObject's
category.
Property Direction (p. 612) Gets or sets the Direction.
Property InternalObject (p. 612) Gets the internal object. For advanced usage
only.
Property Location (p. 612) Gets or sets the Location.
Property ScopingMethod (p. 612) Gets or sets the ScopingMethod.
Property Selection (p. 436) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 435).)
Property Suppressed (p. 437) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 435).)

Axis
Gets or sets the Axis.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 611
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
612 of ANSYS, Inc. and its subsidiaries and affiliates.
ReactionForceConstraint

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

ReactionForceConstraint
Defines a ReactionForceConstraint.

Declaration Syntax
public class ReactionForceConstraint : ResponseConstraint

Table 222: Members

Property AxisSelection (p. 613) Gets or sets the AxisSelection.


Property BoundType (p. 613) Gets or sets the BoundType.
Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 614) Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 614) Gets the internal object. For advanced usage only.
Property Location (p. 614) Gets or sets the Location.
Property ReactionForceCriteria (p. 614) Gets or sets the ReactionForceCriteria.
Property ScopingMethod (p. 614) Gets or sets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)


Property XComponentMax (p. 614) Gets or sets the XComponentMax.
Property YComponentMax (p. 615) Gets or sets the YComponentMax.
Property ZComponentMax (p. 615) Gets or sets the ZComponentMax.

AxisSelection
Gets or sets the AxisSelection.

Declaration Syntax
public AxisSelectionType AxisSelection { set;get; }

BoundType
Gets or sets the BoundType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 613
Ansys.ACT.Automation.Mechanical Namespace

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; }

XComponentMax
Gets or sets the XComponentMax.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
614 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

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; }

RemotePoint
Defines a RemotePoint.

Declaration Syntax
public class RemotePoint : DataModelObject, ISelectionInfo, IFolderDataModelObject

Table 223: Members

Property Behavior (p. 616) Gets or sets the Behavior.


Property Children (p. 616) Gets the list of children.
Property Comments (p. 616) Gets the list of associated comments.
Property CoordinateSystem (p. 617) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 617) Gets the current DataModelObject's category.
Property DOFSelection (p. 617) Gets or sets the DOFSelection.
Property GloballyAvailable (p. 617) Remote point is globally available
Property InternalObject (p. 617) Gets the internal object. For advanced usage only.
Property Location (p. 617) Gets or sets the Location.
Property Material (p. 618) Gets or sets the Material.
Property OutlineSelection (p. 618) Gets or sets the OutlineSelection.
Property PilotNodeAPDLName (p. 618) Gets or sets the PilotNodeAPDLName.
Property PinballRegion (p. 618) Gets or sets the PinballRegion.
Property Radius (p. 618) Gets or sets the Radius.
Property RotationX (p. 618) Gets or sets the RotationX.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 615
Ansys.ACT.Automation.Mechanical Namespace

Property RotationY (p. 619) Gets or sets the RotationY.


Property RotationZ (p. 619) Gets or sets the RotationZ.
Property ScopingMethod (p. 619) Gets or sets the ScopingMethod.
Property Suppressed (p. 619) Gets or sets the Suppressed.
Property XComponent (p. 619) Gets or sets the XComponent.
Property XCoordinate (p. 619) Gets or sets the XCoordinate.
Property YComponent (p. 620) Gets or sets the YComponent.
Property YCoordinate (p. 620) Gets or sets the YCoordinate.
Property ZComponent (p. 620) Gets or sets the ZComponent.
Property ZCoordinate (p. 620) Gets or sets the ZCoordinate.
Method AddCommandSnippet() (p. 620) Creates a new CommandSnippet
Method AddComment() (p. 620) Creates a new child Comment.
Method Delete() (p. 621) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 621)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 621)
Method GetMeshRegion() (p. 621) Returns the mesh region associated to the remote
point.
Method PromoteToNamedSelection() (p. 622) 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<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
616 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

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.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 617
Ansys.ACT.Automation.Mechanical Namespace

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; }

PinballRegion
Gets or sets the PinballRegion.

Declaration Syntax
public Quantity PinballRegion { set;get; }

Radius
Gets or sets the Radius.

Declaration Syntax
public Quantity Radius { set;get; }

RotationX
Gets or sets the RotationX.

Declaration Syntax
public ActiveOrInactive RotationX { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
618 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

RotationY
Gets or sets the RotationY.

Declaration Syntax
public ActiveOrInactive RotationY { set;get; }

RotationZ
Gets or sets the RotationZ.

Declaration Syntax
public ActiveOrInactive RotationZ { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 619
Ansys.ACT.Automation.Mechanical Namespace

YComponent
Gets or sets the YComponent.

Declaration Syntax
public ActiveOrInactive YComponent { set;get; }

YCoordinate
Gets or sets the YCoordinate.

Declaration Syntax
public Quantity YCoordinate { set;get; }

ZComponent
Gets or sets the ZComponent.

Declaration Syntax
public ActiveOrInactive ZComponent { set;get; }

ZCoordinate
Gets or sets the ZCoordinate.

Declaration Syntax
public Quantity ZCoordinate { set;get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
620 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 621
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IMeshRegion GetMeshRegion()

PromoteToNamedSelection()
Run the PromoteToNamedSelection action.

Declaration Syntax
public virtual IEnumerable<NamedSelection> PromoteToNamedSelection()

RemotePoints
Defines a RemotePoints.

Declaration Syntax
public class RemotePoints : DataModelObject, IFolderDataModelObject

Table 224: Members

Property Children (p. 622) Gets the list of children.


Property Comments (p. 623) Gets the list of associated comments.
Property DataModelObjectCategory (p. 623) Gets the current DataModelObject's category.
Property Figures (p. 623) Gets the list of associated figures.
Property Images (p. 623) Gets the list of associated images.
Property InternalObject (p. 623) Gets the internal object. For advanced usage only.
Property ShowConnectionLines (p. 623) Gets or sets the ShowConnectionLines.
Method AddComment() (p. 624) Creates a new child Comment.
Method AddFigure() (p. 624) Creates a new child Figure.
Method AddImage(string) (p. 624) Creates a new child Image. If a 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. 624) Creates a new RemotePoint
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 624)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 625)

Children
Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
622 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoints

Declaration Syntax
public IList<DataModelObject> 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 IDSRemotePointGroupAuto InternalObject { get; }

ShowConnectionLines
Gets or sets the ShowConnectionLines.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 623
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool ShowConnectionLines { 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.

AddRemotePoint()
Creates a new RemotePoint

Declaration Syntax
public virtual RemotePoint AddRemotePoint()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
624 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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 225: Members

Property Children (p. 626) Gets the list of children.


Property DataModelObjectCategory (p. 626) Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an
Analysis object or TopoEnvironmentType
enum.
Property InternalObject (p. 626) Gets the internal object. For advanced usage
only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 625
Ansys.ACT.Automation.Mechanical Namespace

Property Suppressed (p. 626) Gets or sets the Suppressed.


Method Delete() (p. 627) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 627)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 627)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
626 of ANSYS, Inc. and its subsidiaries and affiliates.
ResponsePSDTool

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ResponsePSDTool
Defines a ResponsePSDTool.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 627
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ResponsePSDTool : DataModelObject, IFolderDataModelObject

Table 226: Members

Property Children (p. 628) Gets the list of children.


Property ClusteringFrequencyPoints (p. 628) Gets or sets the ClusteringFrequencyPoints.
Property Comments (p. 629) Gets the list of associated comments.
Property DataModelObjectCategory (p. 629) Gets the current DataModelObject's category.
Property Figures (p. 629) Gets the list of associated figures.
Property Images (p. 629) Gets the list of associated images.
Property IncludeAllExcitationFrequencies (p. 629) Gets or sets the IncludeAllExcitationFrequencies.
Property IncludeUserDefinedFrequencies (p. 629) Gets or sets the IncludeUserDefinedFrequencies.
Property InternalObject (p. 630) Gets the internal object. For advanced usage only.
Method AddComment() (p. 630) Creates a new child Comment.
Method AddFigure() (p. 630) Creates a new child Figure.
Method AddImage(string) (p. 630) Creates a new child Image. If a 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. 630) Creates a new ResponsePSD
Method Delete() (p. 630) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 631)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 631)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

ClusteringFrequencyPoints
Gets or sets the ClusteringFrequencyPoints.

Declaration Syntax
public int ClusteringFrequencyPoints { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
628 of ANSYS, Inc. and its subsidiaries and affiliates.
ResponsePSDTool

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

IncludeAllExcitationFrequencies
Gets or sets the IncludeAllExcitationFrequencies.

Declaration Syntax
public bool IncludeAllExcitationFrequencies { set;get; }

IncludeUserDefinedFrequencies
Gets or sets the IncludeUserDefinedFrequencies.

Declaration Syntax
public bool IncludeUserDefinedFrequencies { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 629
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResponsePSDToolAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

AddResponsePSD()
Creates a new ResponsePSD

Declaration Syntax
public virtual ResponsePSD AddResponsePSD()

Delete()
Run the Delete action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
630 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

SelectionWorksheet
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 631
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class SelectionWorksheet : Worksheet, ISelectionInfo

Table 227: Members

Property RowCount (p. 633) No details are provided for this entry.
Method AddRow() (p. 633) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 634) Deletes a row from the worksheet at
index.
Method Generate() (p. 634) Generate the selection from the
worksheet.
Method GetAction(int) (p. 634) Gets the worksheet Action property at
index.
Method GetBodyTypeValue(int) (p. 634) Gets the worksheet Body Type Value
property at index.
Method GetCoordinateSystemSelection(int) (p. 635) Gets the worksheet
CoordinateSystemSelection property at
index.
Method GetCriterion(int) (p. 635) Gets the worksheet Criterion property
at index.
Method GetCriterionActive(int) (p. 635) Gets the worksheet CriterionActive
property at index.
Method GetEdgeTypeValue(int) (p. 635) Gets the worksheet Edge Type Value
property at index.
Method GetFaceTypeValue(int) (p. 636) Gets the worksheet Face Type Value
property at index.
Method GetGeometryType(int) (p. 636) Gets the worksheet GeometryType
property at index.
Method GetLowerBound(int) (p. 636) Gets the worksheet LowerBound
property at index.
Method GetMeshElementTypeValue(int) (p. 636) Gets the worksheet Mesh Element Type
Value property at index.
Method GetOperator(int) (p. 637) Gets the worksheet Operator property
at index.
Method GetStringValue(int) (p. 637) Gets the worksheet StringValue
property at index.
Method GetTag(uint) (p. 637) Gets the worksheet Tag property at
index.
Method GetUpperBound(int) (p. 638) Gets the worksheet UpperBound
property at index.
Method GetValue(int) (p. 638) Gets the worksheet Value property at
index.
Method SetAction(int, Sets the worksheet Action property at
NamedSelectionWorksheetAction) (p. 638) index.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
632 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Method SetBodyTypeValue(int, Sets the worksheet Body Type Value


NamedSelectionWorksheetBodyTypeValues) (p. 638) property at index.
Method SetCoordinateSystemSelection(int, uint) (p. 639) Sets the worksheet
CoordinateSystemSelection property at
index.
Method SetCriterion(int, Sets the worksheet Criterion property
NamedSelectionWorksheetCriterion) (p. 639) at index.
Method SetCriterionActive(int, bool) (p. 639) Sets the worksheet CriterionActive
property at index.
Method SetEdgeTypeValue(int, Sets the worksheet Edge Type Value
NamedSelectionWorksheetEdgeTypeValues) (p. 640) property at index.
Method SetEntityType(int, Sets the worksheet GeometryType
NamedSelectionWorksheetEntityType) (p. 640) property at index.
Method SetFaceTypeValue(int, Sets the worksheet Face Type Value
NamedSelectionWorksheetFaceTypeValues) (p. 640) property at index.
Method SetLowerBound(int, double) (p. 641) Sets the worksheet LowerBound
property at index.
Method SetMeshElementTypeValue(int, Sets the worksheet Mesh Element Type
MeshElementShape) (p. 641) Value property at index.
Method SetOperator(int, Sets the worksheet Operator property
NamedSelectionWorksheetOperator) (p. 641) at index.
Method SetStringValue(int, string) (p. 642) Sets the worksheet StringValue
property at index.
Method SetTag(uint, string) (p. 642) Sets the worksheet Tag property at
index.
Method SetUpperBound(int, double) (p. 642) Sets the worksheet UpperBound
property at index.
Method SetValue(int, double) (p. 643) Sets the worksheet Value property at
index.

RowCount
No details are provided for this entry.

Declaration Syntax
public int RowCount { get; }

AddRow()
Adds a Row to the worksheet.

Declaration Syntax
public override int AddRow()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 633
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public NamedSelectionWorksheetBodyTypeValues GetBodyTypeValue(int index)

Parameters
index(int)
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
634 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

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)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 635
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
636 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

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)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 637
Ansys.ACT.Automation.Mechanical Namespace

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.

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
638 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

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.

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 639
Ansys.ACT.Automation.Mechanical Namespace

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)

Parameters
index(int)
No details are provided for this entry.

newVal(NamedSelectionWorksheetEdgeTypeValues)
No details are provided for this entry.

SetEntityType(int, NamedSelectionWorksheetEntityType)
Sets the worksheet GeometryType property at index.

Declaration Syntax
public void SetEntityType(int index, NamedSelectionWorksheetEntityType newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(NamedSelectionWorksheetEntityType)
No details are provided for this entry.

SetFaceTypeValue(int, NamedSelectionWorksheetFaceTypeValues)
Sets the worksheet Face Type Value property at index.

Declaration Syntax
public void SetFaceTypeValue(int index, NamedSelectionWorksheetFaceTypeValues newVal)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
640 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Parameters
index(int)
No details are provided for this entry.

newVal(NamedSelectionWorksheetFaceTypeValues)
No details are provided for this entry.

SetLowerBound(int, double)
Sets the worksheet LowerBound property at index.

Declaration Syntax
public void SetLowerBound(int index, double newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(double)
No details are provided for this entry.

SetMeshElementTypeValue(int, MeshElementShape)
Sets the worksheet Mesh Element Type Value property at index.

Declaration Syntax
public void SetMeshElementTypeValue(int index, MeshElementShape newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(MeshElementShape)
No details are provided for this entry.

SetOperator(int, NamedSelectionWorksheetOperator)
Sets the worksheet Operator property at index.

Declaration Syntax
public void SetOperator(int index, NamedSelectionWorksheetOperator newVal)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 641
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)
No details are provided for this entry.

newVal(NamedSelectionWorksheetOperator)
No details are provided for this entry.

SetStringValue(int, string)
Sets the worksheet StringValue property at index.

Declaration Syntax
public void SetStringValue(int index, string newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(string)
No details are provided for this entry.

SetTag(uint, string)
Sets the worksheet Tag property at index.

Declaration Syntax
public void SetTag(uint index, string newVal)

Parameters
index(uint)
No details are provided for this entry.

newVal(string)
No details are provided for this entry.

SetUpperBound(int, double)
Sets the worksheet UpperBound property at index.

Declaration Syntax
public void SetUpperBound(int index, double newVal)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
642 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

Parameters
index(int)
No details are provided for this entry.

newVal(double)
No details are provided for this entry.

SetValue(int, double)
Sets the worksheet Value property at index.

Declaration Syntax
public void SetValue(int index, double newVal)

Parameters
index(int)
No details are provided for this entry.

newVal(double)
No details are provided for this entry.

SemiEllipticalCrack
Defines a SemiEllipticalCrack.

Declaration Syntax
public class SemiEllipticalCrack : GenericCrack

Table 228: Members

Property AlignWithFaceNormal (p. 644) Gets or sets the AlignWithFaceNormal.


Property BottomFaceNodes (p. 644) Gets or sets the BottomFaceNodes.
Property Children (p. 347) Gets the list of children.

(Inherited from GenericCrack (p. 347).)


Property CircumferentialDivisions (p. 645) Gets or sets the CircumferentialDivisions.
Property Comments (p. 348) Gets the list of associated comments.

(Inherited from GenericCrack (p. 347).)


Property Contact1Nodes (p. 645) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 645) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 645) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 645) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 645) Gets or sets the CrackFrontDivisions.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 643
Ansys.ACT.Automation.Mechanical Namespace

Property CrackFrontNodes (p. 646) Gets or sets the CrackFrontNodes.


Property CrackMeshMethod (p. 646) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 646) Gets the CrackShape.
Property CrackSourceType (p. 646) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 646) Gets the current DataModelObject's
category.
Property Figures (p. 348) Gets the list of associated figures.

(Inherited from GenericCrack (p. 347).)


Property FractureAffectedZone (p. 646) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 647) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 647) Gets or sets the FrontElementSize.
Property GrowthRate (p. 647) Gets or sets the GrowthRate.
Property Images (p. 348) Gets the list of associated images.

(Inherited from GenericCrack (p. 347).)


Property InternalObject (p. 647) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 647) Gets or sets the LargestContourRadius.
Property Location (p. 647) Gets or sets the Location.
Property MajorRadius (p. 648) Gets or sets the MajorRadius.
Property MeshContours (p. 648) Gets or sets the MeshContours.
Property MinorRadius (p. 648) Gets or sets the MinorRadius.
Property ProjectToNearestSurface (p. 648) Gets or sets the ProjectToNearestSurface.
Property SolutionContours (p. 648) Gets or sets the SolutionContours.
Property Suppressed (p. 648) Gets or sets the Suppressed.
Property Target1Nodes (p. 649) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 649) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 649) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 649) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 649) 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
644 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 645
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
646 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 647
Ansys.ACT.Automation.Mechanical Namespace

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
648 of ANSYS, Inc. and its subsidiaries and affiliates.
SMARTCrackGrowth

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 649
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class SMARTCrackGrowth : GenericDelamination

Table 229: Members

Property Analysis (p. 651) Gets the Analysis.


Property AutomaticTimeStepping (p. 651) Gets or sets the AutomaticTimeStepping.
Property Children (p. 351) Gets the list of children.

(Inherited from GenericDelamination (p. 350).)


Property Comments (p. 351) Gets the list of associated comments.

(Inherited from GenericDelamination (p. 350).)


Property CrackGrowthLaw (p. 651) Gets the CrackGrowthLaw.
Property CrackGrowthMethodology (p. 651) Gets or sets the CrackGrowthMethodology.
Property CrackGrowthOption (p. 651) Gets or sets the CrackGrowthOption.
Property CriticalRate (p. 651) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 652) Gets the current DataModelObject's
category.
Property FailureCriteriaOption (p. 652) Gets or sets the FailureCriteriaOption.
Property Figures (p. 351) Gets the list of associated figures.

(Inherited from GenericDelamination (p. 350).)


Property Images (p. 351) Gets the list of associated images.

(Inherited from GenericDelamination (p. 350).)


Property InitialCrack (p. 652) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 652) Gets or sets the InitialTimeStep.
Property InternalObject (p. 652) Gets the internal object. For advanced usage
only.
Property Material (p. 652) Gets or sets the Material.
Property MaximumTimeStep (p. 653) Gets or sets the MaximumTimeStep.
Property MaxIncrementOfCrackExtension (p. 653) Gets or sets the
MaxIncrementOfCrackExtension.
Property MaxIncrementValue (p. 653) Gets or sets the MaxIncrementValue.
Property Method (p. 653) Gets the Method.
Property MinimumTimeStep (p. 653) Gets or sets the MinimumTimeStep.
Property MinIncrementOfCrackExtension (p. 653) Gets or sets the
MinIncrementOfCrackExtension.
Property MinIncrementValue (p. 654) Gets or sets the MinIncrementValue.
Property NumberOfCycles (p. 654) Gets or sets the NumberOfCycles.
Property StopAtMaxCrackExtension (p. 654) Gets or sets the StopAtMaxCrackExtension.
Property StopAtMaxCrackExtensionValue (p. 654) Gets or sets the
StopAtMaxCrackExtensionValue.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
650 of ANSYS, Inc. and its subsidiaries and affiliates.
SMARTCrackGrowth

Property StressRatio (p. 654) Gets or sets the StressRatio.


Property Suppressed (p. 654) 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; }

CriticalRate
Gets or sets the CriticalRate.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 651
Ansys.ACT.Automation.Mechanical Namespace

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; }

Material
Gets or sets the Material.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
652 of ANSYS, Inc. and its subsidiaries and affiliates.
SMARTCrackGrowth

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; }

MinIncrementOfCrackExtension
Gets or sets the MinIncrementOfCrackExtension.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 653
Ansys.ACT.Automation.Mechanical Namespace

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; }

Suppressed
Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
654 of ANSYS, Inc. and its subsidiaries and affiliates.
Solid

Declaration Syntax
public bool Suppressed { set;get; }

Solid
Defines a Solid.

Declaration Syntax
public class Solid : DataModelObject, IFolderDataModelObject

Table 230: Members

Property Children (p. 655) Gets the list of children.


Property Comments (p. 656) Gets the list of associated comments.
Property CoordinateSystem (p. 656) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 656) Gets the current DataModelObject's
category.
Property InternalObject (p. 656) Gets the internal object. For advanced usage
only.
Property PartName (p. 656) Gets the PartName.
Property X1 (p. 656) Gets or sets the X1.
Property X2 (p. 657) Gets or sets the X2.
Property Y1 (p. 657) Gets or sets the Y1.
Property Y2 (p. 657) Gets or sets the Y2.
Property Z1 (p. 657) Gets or sets the Z1.
Property Z2 (p. 657) Gets or sets the Z2.
Method AddComment() (p. 657) Creates a new child Comment.
Method AddGeometry() (p. 658) Add solid to the geometry.
Method Delete() (p. 658) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 658)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 658)
Method RemoveGeometry() (p. 659) Remove the solid from the geometry.
Method UpdateGeometry() (p. 659) Update the solid on the geometry.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 655
Ansys.ACT.Automation.Mechanical Namespace

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; }

X1
Gets or sets the X1.

Declaration Syntax
public Quantity X1 { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
656 of ANSYS, Inc. and its subsidiaries and affiliates.
Solid

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; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 657
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
658 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

children(IList<DataModelObject>)
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 231: Members

Property AllThreadsCPUTime (p. 668) No details are provided for this entry.
Property CalculateBeamSectionResults (p. 668) Gets or sets the CalculateBeamSectionResult
Property CellId (p. 668) Gets the CellId.
Property Children (p. 668) Gets the list of children.
Property Comments (p. 669) Gets the list of associated comments.
Property CyclicSectorDisplayRangeBegin (p. 669) Gets or sets the
CyclicSectorDisplayRangeBegin.
Property DataModelObjectCategory (p. 669) Gets the current DataModelObject's categor
Property EigenSolverType (p. 669) No details are provided for this entry.
Property ElapsedRunTime (p. 669) Gets or sets the ElapsedRunTime.
Property ElapsedTime (p. 669) No details are provided for this entry.
Property ElementLoadBalRatio (p. 670) No details are provided for this entry.
Property Elements (p. 670) No details are provided for this entry.
Property ElementSelection (p. 670) Gets or sets the ElementSelection.
Property EquationSolverType (p. 670) No details are provided for this entry.
Property ExportTopologyFile (p. 670) Gets or sets the ExportTopologyFile.
Property Figures (p. 670) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 659
Ansys.ACT.Automation.Mechanical Namespace

Property GpuAcceleration (p. 671) No details are provided for this entry.
Property GPUType (p. 671) No details are provided for this entry.
Property Images (p. 671) Gets the list of associated images.
Property InternalObject (p. 671) Gets the internal object. For advanced usage
only.
Property IOBound (p. 671) No details are provided for this entry.
Property IORead (p. 671) No details are provided for this entry.
Property IOWrite (p. 672) No details are provided for this entry.
Property IsDataExtractionComplete (p. 672) No details are provided for this entry.
Property IsDistributedSolution (p. 672) No details are provided for this entry.
Property IsEigenSolver (p. 672) No details are provided for this entry.
Property IsGPUAccelerationRequested (p. 672) No details are provided for this entry.
Property IsUnsymmetricMatrixSolve (p. 672) No details are provided for this entry.
Property License (p. 673) No details are provided for this entry.
Property LicenseCoresAvailable (p. 673) No details are provided for this entry.
Property MainThreadCPUTime (p. 673) No details are provided for this entry.
Property MaximumRefinementLoops (p. 673) Gets or sets the MaximumRefinementLoops.
Property MemoryAvailable (p. 673) No details are provided for this entry.
Property MemoryUsed (p. 673) Gets or sets the MemoryUsed.
Property MPIType (p. 674) No details are provided for this entry.
Property MSUPHarmonicAnalysis (p. 674) No details are provided for this entry.
Property Nodes (p. 674) No details are provided for this entry.
Property NumberofSectors (p. 674) Gets or sets the NumberofSectors.
Property NumCoresAvailable (p. 674) No details are provided for this entry.
Property NumGPURequested (p. 674) No details are provided for this entry.
Property NumMachinesRequested (p. 675) No details are provided for this entry.
Property NumProcRequested (p. 675) No details are provided for this entry.
Property NumVirtualCoresAvailable (p. 675) No details are provided for this entry.
Property OperatingSystem (p. 675) No details are provided for this entry.
Property ProcessorModel (p. 675) No details are provided for this entry.
Property RefinementDepth (p. 675) Gets or sets the RefinementDepth.
Property ResultFileSize (p. 676) Gets the ResultFileSize.
Property SolutionInformation (p. 676) Gets the SolutionInformation.
Property SolutionUnitSystem (p. 676) No details are provided for this entry.
Property SolverData (p. 676) No details are provided for this entry.
Property SolverType (p. 676) No details are provided for this entry.
Property Status (p. 676) Gets the Status.
Property TabularData (p. 677) Gets the tabular data of the solution. Use a
to get index to each column of the tabular
data.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
660 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Property TimeToCombineDistributedFiles (p. 677) No details are provided for this entry.
Property TopologyResult (p. 677) Gets or sets the TopologyResult.
Property TotalMemoryUsed (p. 677) No details are provided for this entry.
Property WorkingDir (p. 677) Gets the WorkingDir.
Method AddAccelerationFrequencyResponse() (p. 677) Creates a new
AccelerationFrequencyResponse
Method AddAccelerationPhaseResponse() (p. 678) Creates a new AccelerationPhaseResponse
Method AddAccelerationProbe() (p. 678) Creates a new AccelerationProbe
Method AddAccumulatedEquivalentPlasticStrain() (p. 678) Creates a new
AccumulatedEquivalentPlasticStrain
Method AddAcousticAbsorptionCoefficient() (p. 678) Creates a new AcousticAbsorptionCoefficien
Method AddAcousticAWeightedSoundPressureLevel() (p. 678) Creates a new
AcousticAWeightedSoundPressureLevel
Method AddAcousticAWeightedSPLFrequencyResponse() (p. 678) Creates a new
AcousticAWeightedSPLFrequencyResponse
Method AddAcousticDiffuseSoundTransmissionLoss() (p. 679) Creates a new
AcousticDiffuseSoundTransmissionLoss
Method AddAcousticDirectionalVelocityResult() (p. 679) Creates a new
AcousticDirectionalVelocityResult
Method AddAcousticFarFieldAWeightedSPL() (p. 679) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldAWeightedSPLMic() (p. 679) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldDirectivity() (p. 679) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldMaximumPressure() (p. 679) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldMaximumPressureMic() (p. 680) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldMaximumScatteredPressure() (p. 680) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldPhase() (p. 680) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldPhaseMic() (p. 680) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldSoundPowerLevel() (p. 680) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldSoundPowerLevelWaterfallDiagram() (p. 680) Creates a new
AcousticFarFieldSoundPowerLevelWaterfallD
Method AddAcousticFarFieldSPL() (p. 681) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldSPLMic() (p. 681) Creates a new AcousticFarFieldResult
Method AddAcousticFarFieldSPLMicWaterfallDiagram() (p. 681) Creates a new
AcousticFarFieldSPLMicWaterfallDiagram
Method AddAcousticFarFieldTargetStrength() (p. 681) Creates a new AcousticFarFieldResult
Method AddAcousticFrequencyBandAWeightedSPL() (p. 681) Creates a new
AcousticFrequencyBandAWeightedSPL
Method AddAcousticFrequencyBandSPL() (p. 681) Creates a new AcousticFrequencyBandSPL
Method AddAcousticKineticEnergy() (p. 682) Creates a new AcousticKineticEnergy
Method AddAcousticKineticEnergyFrequencyResponse() (p. 682) Creates a new
AcousticKineticEnergyFrequencyResponse
Method AddAcousticPotentialEnergy() (p. 682) Creates a new AcousticPotentialEnergy

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 661
Ansys.ACT.Automation.Mechanical Namespace

Method AddAcousticPotentialEnergyFrequencyResponse() (p. 682) Creates a new


AcousticPotentialEnergyFrequencyResponse
Method AddAcousticPressureFrequencyResponse() (p. 682) Creates a new
AcousticPressureFrequencyResponse
Method AddAcousticPressureResult() (p. 682) Creates a new AcousticPressureResult
Method AddAcousticReturnLoss() (p. 683) Creates a new AcousticReturnLoss
Method AddAcousticSoundPressureLevel() (p. 683) Creates a new AcousticSoundPressureLevel
Method AddAcousticSPLFrequencyResponse() (p. 683) Creates a new
AcousticSPLFrequencyResponse
Method AddAcousticTotalVelocityResult() (p. 683) Creates a new AcousticTotalVelocityResult
Method AddAcousticTransmissionLoss() (p. 683) Creates a new AcousticTransmissionLoss
Method AddAcousticVelocityFrequencyResponse() (p. 683) Creates a new
AcousticVelocityFrequencyResponse
Method AddAngularAccelerationProbe() (p. 684) Creates a new AngularAccelerationProbe
Method AddAngularVelocityProbe() (p. 684) Creates a new AngularVelocityProbe
Method AddBeamProbe() (p. 684) Creates a new BeamProbe
Method AddBeamTool() (p. 684) Creates a new BeamTool
Method AddBearingProbe() (p. 684) Creates a new BearingProbe
Method AddBendingStressEquivalent() (p. 684) Creates a new BendingStressEquivalent
Method AddBendingStressIntensity() (p. 685) Creates a new BendingStressIntensity
Method AddBoltPretensionProbe() (p. 685) Creates a new BoltPretensionProbe
Method AddBoltTool() (p. 685) Creates a new BoltTool
Method AddCampbellDiagram() (p. 685) Creates a new CampbellDiagram
Method AddCommandSnippet() (p. 685) Creates a new CommandSnippet
Method AddComment() (p. 685) Creates a new child Comment.
Method AddCompositeCriterion() (p. 686) Creates a new CompositeCriterion
Method AddContactTool() (p. 686) Creates a new ContactTool
Method AddCurrentDensity() (p. 686) Creates a new CurrentDensity
Method AddCurrentDensityProbe() (p. 686) Creates a new CurrentDensityProbe
Method AddDamageStatus() (p. 686) Creates a new DamageStatus
Method AddDeformationFrequencyResponse() (p. 686) Creates a new
DeformationFrequencyResponse
Method AddDeformationPhaseResponse() (p. 687) Creates a new DeformationPhaseResponse
Method AddDeformationProbe() (p. 687) Creates a new DeformationProbe
Method AddDirectionalAcceleration() (p. 687) Creates a new DirectionalAcceleration
Method AddDirectionalAccelerationPSD() (p. 687) Creates a new DirectionalAccelerationPSD
Method AddDirectionalAccelerationRS() (p. 687) Creates a new DirectionalAccelerationRS
Method AddDirectionalAxialForce() (p. 687) Creates a new DirectionalAxialForce
Method AddDirectionalBendingMoment() (p. 688) Creates a new DirectionalBendingMoment
Method AddDirectionalCurrentDensity() (p. 688) Creates a new DirectionalCurrentDensity
Method AddDirectionalDeformation() (p. 688) Creates a new DirectionalDeformation

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
662 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddDirectionalElectricFieldIntensity() (p. 688) Creates a new DirectionalElectricFieldIntensi


Method AddDirectionalHeatFlux() (p. 688) Creates a new DirectionalHeatFlux
Method AddDirectionalMagneticFieldIntensity() (p. 688) Creates a new
DirectionalMagneticFieldIntensity
Method AddDirectionalMagneticFluxDensity() (p. 689) Creates a new DirectionalMagneticFluxDensi
Method AddDirectionalShearForce() (p. 689) Creates a new DirectionalShearForce
Method AddDirectionalTorsionalMoment() (p. 689) Creates a new DirectionalTorsionalMoment
Method AddDirectionalVelocity() (p. 689) Creates a new DirectionalVelocity
Method AddDirectionalVelocityPSD() (p. 689) Creates a new DirectionalVelocityPSD
Method AddDirectionalVelocityRS() (p. 689) Creates a new DirectionalVelocityRS
Method AddElasticStrainFrequencyResponse() (p. 690) Creates a new ElasticStrainFrequencyRespon
Method AddElasticStrainIntensity() (p. 690) Creates a new ElasticStrainIntensity
Method AddElasticStrainPhaseResponse() (p. 690) Creates a new ElasticStrainPhaseResponse
Method AddElectricFieldProbe() (p. 690) Creates a new ElectricFieldProbe
Method AddElectricPotential() (p. 690) Creates a new ElectricPotential
Method AddElectricVoltage() (p. 690) Creates a new ElectricVoltage
Method AddElementalEulerXYAngle() (p. 691) Creates a new ElementalEulerXYAngle
Method AddElementalEulerXZAngle() (p. 691) Creates a new ElementalEulerXZAngle
Method AddElementalEulerYZAngle() (p. 691) Creates a new ElementalEulerYZAngle
Method AddElementalStrainEnergy() (p. 691) Creates a new ElementalStrainEnergy
Method AddElementalTriads() (p. 691) Creates a new ElementalTriads
Method AddEmagReactionProbe() (p. 691) Creates a new EmagReactionProbe
Method AddEnergyDissipatedPerUnitVolume() (p. 692) Creates a new
EnergyDissipatedPerUnitVolume
Method AddEnergyProbe() (p. 692) Creates a new EnergyProbe
Method AddEquivalentCreepStrain() (p. 692) Creates a new EquivalentCreepStrain
Method AddEquivalentCreepStrainRST() (p. 692) Creates a new EquivalentCreepStrainRST
Method AddEquivalentElasticStrain() (p. 692) Creates a new EquivalentElasticStrain
Method AddEquivalentElasticStrainRST() (p. 692) Creates a new EquivalentElasticStrainRST
Method AddEquivalentPlasticStrain() (p. 693) Creates a new EquivalentPlasticStrain
Method AddEquivalentPlasticStrainRST() (p. 693) Creates a new EquivalentPlasticStrainRST
Method AddEquivalentRadiatedPower() (p. 693) Creates a new EquivalentRadiatedPower
Method AddEquivalentRadiatedPowerLevel() (p. 693) Creates a new EquivalentRadiatedPowerLeve
Method AddEquivalentRadiatedPowerLevelWaterfallDiagram() (p. 693) Creates a new
EquivalentRadiatedPowerLevelWaterfallDiagr
Method AddEquivalentRadiatedPowerWaterfallDiagram() (p. 693) Creates a new
EquivalentRadiatedPowerWaterfallDiagram
Method AddEquivalentStress() (p. 694) Creates a new EquivalentStress
Method AddEquivalentStressPSD() (p. 694) Creates a new EquivalentStressPSD
Method AddEquivalentStressRS() (p. 694) Creates a new EquivalentStressRS

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 663
Ansys.ACT.Automation.Mechanical Namespace

Method AddEquivalentTotalStrain() (p. 694) Creates a new EquivalentTotalStrain


Method AddExpansionSettings() (p. 694) Creates a new ExpansionSettings
Method AddFatigueTool() (p. 694) Creates a new FatigueTool
Method AddFiberCompressiveDamageVariable() (p. 695) Creates a new
FiberCompressiveDamageVariable
Method AddFiberCompressiveFailureCriterion() (p. 695) Creates a new
FiberCompressiveFailureCriterion
Method AddFiberTensileDamageVariable() (p. 695) Creates a new FiberTensileDamageVariable
Method AddFiberTensileFailureCriterion() (p. 695) Creates a new FiberTensileFailureCriterion
Method AddFieldIntensityProbe() (p. 695) Creates a new FieldIntensityProbe
Method AddFigure() (p. 695) Creates a new child Figure.
Method AddFluidFlowRate() (p. 696) Creates a new FluidFlowRate
Method AddFluidHeatConductionRate() (p. 696) Creates a new FluidHeatConductionRate
Method AddFluidHeatTransportRate() (p. 696) Creates a new FluidHeatTransportRate
Method AddFluxDensityProbe() (p. 696) Creates a new FluxDensityProbe
Method AddFluxLinkage() (p. 696) Creates a new FluxLinkage
Method AddForceReaction() (p. 696) Creates a new ForceReaction
Method AddForceSummationProbe() (p. 697) Creates a new ForceSummationProbe
Method AddFractureTool() (p. 697) Creates a new FractureTool
Method AddGeneralizedPlaneStrainProbe() (p. 697) Creates a new GeneralizedPlaneStrainProbe
Method AddHeatFluxProbe() (p. 697) Creates a new HeatFluxProbe
Method AddImage(string) (p. 697) Creates a new child Image. If a filePath is
provided, the image will be loaded from tha
file, if not, the image will be a screen capture
of the Geometry window.
Method AddInductance() (p. 697) Creates a new Inductance
Method AddJointProbe() (p. 698) Creates a new JointProbe
Method AddJouleHeat() (p. 698) Creates a new JouleHeat
Method AddJouleHeatProbe() (p. 698) Creates a new JouleHeatProbe
Method AddLatticeDensity() (p. 698) Creates a new LatticeDensity
Method AddLatticeElementalDensity() (p. 698) Creates a new LatticeElementalDensity
Method AddLinearizedEquivalentStress() (p. 698) Creates a new LinearizedEquivalentStress
Method AddLinearizedMaximumPrincipalStress() (p. 699) Creates a new
LinearizedMaximumPrincipalStress
Method AddLinearizedMaximumShearStress() (p. 699) Creates a new LinearizedMaximumShearStre
Method AddLinearizedMiddlePrincipalStress() (p. 699) Creates a new LinearizedMiddlePrincipalStre
Method AddLinearizedMinimumPrincipalStress() (p. 699) Creates a new
LinearizedMinimumPrincipalStress
Method AddLinearizedNormalStress() (p. 699) Creates a new LinearizedNormalStress
Method AddLinearizedShearStress() (p. 699) Creates a new LinearizedShearStress
Method AddLinearizedStressIntensity() (p. 700) Creates a new LinearizedStressIntensity

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
664 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddMagneticCoenergy() (p. 700) Creates a new MagneticCoenergy


Method AddMagneticDirectionalForces() (p. 700) Creates a new MagneticDirectionalForces
Method AddMagneticError() (p. 700) Creates a new MagneticError
Method AddMagneticFluxProbe() (p. 700) Creates a new MagneticFluxProbe
Method AddMagneticPotential() (p. 700) Creates a new MagneticPotential
Method AddMagneticTotalForces() (p. 701) Creates a new MagneticTotalForces
Method AddMatrixCompressiveDamageVariable() (p. 701) Creates a new
MatrixCompressiveDamageVariable
Method AddMatrixCompressiveFailureCriterion() (p. 701) Creates a new
MatrixCompressiveFailureCriterion
Method AddMatrixTensileDamageVariable() (p. 701) Creates a new MatrixTensileDamageVariable
Method AddMatrixTensileFailureCriterion() (p. 701) Creates a new MatrixTensileFailureCriterion
Method AddMaximumFailureCriteria() (p. 701) Creates a new MaximumFailureCriteria
Method AddMaximumPrincipalElasticStrain() (p. 702) Creates a new MaximumPrincipalElasticStrain
Method AddMaximumPrincipalStress() (p. 702) Creates a new MaximumPrincipalStress
Method AddMaximumPrincipalThermalStrain() (p. 702) Creates a new
MaximumPrincipalThermalStrain
Method AddMaximumShearElasticStrain() (p. 702) Creates a new MaximumShearElasticStrain
Method AddMaximumShearStress() (p. 702) Creates a new MaximumShearStress
Method AddMembraneStressEquivalent() (p. 702) Creates a new MembraneStressEquivalent
Method AddMembraneStressIntensity() (p. 703) Creates a new MembraneStressIntensity
Method AddMiddlePrincipalElasticStrain() (p. 703) Creates a new MiddlePrincipalElasticStrain
Method AddMiddlePrincipalStress() (p. 703) Creates a new MiddlePrincipalStress
Method AddMiddlePrincipalThermalStrain() (p. 703) Creates a new MiddlePrincipalThermalStrain
Method AddMinimumPrincipalElasticStrain() (p. 703) Creates a new MinimumPrincipalElasticStrain
Method AddMinimumPrincipalStress() (p. 703) Creates a new MinimumPrincipalStress
Method AddMomentReaction() (p. 704) Creates a new MomentReaction
Method AddMullinsDamageVariable() (p. 704) Creates a new MullinsDamageVariable
Method AddMullinsMaximumPreviousStrainEnergy() (p. 704) Creates a new
MullinsMaximumPreviousStrainEnergy
Method AddNewtonRaphsonResidualForce() (p. 704) Creates a new NewtonRaphsonResidualForce
Method AddNewtonRaphsonResidualHeat() (p. 704) Creates a new NewtonRaphsonResidualHeat
Method AddNewtonRaphsonResidualMoment() (p. 704) Creates a new
NewtonRaphsonResidualMoment
Method AddNodalEulerXYAngle() (p. 705) Creates a new NodalEulerXYAngle
Method AddNodalEulerXZAngle() (p. 705) Creates a new NodalEulerXZAngle
Method AddNodalEulerYZAngle() (p. 705) Creates a new NodalEulerYZAngle
Method AddNodalTriads() (p. 705) Creates a new NodalTriads
Method AddNormalElasticStrain() (p. 705) Creates a new NormalElasticStrain
Method AddNormalGasketPressure() (p. 705) Creates a new NormalGasketPressure
Method AddNormalGasketTotalClosure() (p. 706) Creates a new NormalGasketTotalClosure

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 665
Ansys.ACT.Automation.Mechanical Namespace

Method AddNormalStress() (p. 706) Creates a new NormalStress


Method AddPosition() (p. 706) Creates a new Position
Method AddPrimaryCriterion() (p. 706) Creates a new PrimaryCriterion
Method AddRadiationProbe() (p. 706) Creates a new RadiationProbe
Method AddReactionProbe() (p. 706) Creates a new ReactionProbe
Method AddResponsePSD() (p. 707) Creates a new ResponsePSD
Method AddResponsePSDTool() (p. 707) Creates a new ResponsePSDTool
Method AddRotationProbe() (p. 707) Creates a new RotationProbe
Method AddShapeFinder() (p. 707) Creates a new ShapeFinder
Method AddShapeFinderElemental() (p. 707) Creates a new ShapeFinderElemental
Method AddShearDamageVariable() (p. 707) Creates a new ShearDamageVariable
Method AddShearElasticStrain() (p. 708) Creates a new ShearElasticStrain
Method AddShearGasketPressure() (p. 708) Creates a new ShearGasketPressure
Method AddShearGasketTotalClosure() (p. 708) Creates a new ShearGasketTotalClosure
Method AddShearMomentDiagramMSUM() (p. 708) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramMY() (p. 708) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramMZ() (p. 708) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUSUM() (p. 709) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramUY() (p. 709) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUZ() (p. 709) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVSUM() (p. 709) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramVY() (p. 709) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVZ() (p. 709) Creates a new
DirectionalShearMomentDiagram
Method AddShearStress() (p. 710) Creates a new ShearStress
Method AddShellBendingStress() (p. 710) Creates a new ShellBendingStress
Method AddShellBottomPeakStress() (p. 710) Creates a new ShellBottomPeakStress
Method AddShellMembraneStress() (p. 710) Creates a new ShellMembraneStress
Method AddShellTopPeakStress() (p. 710) Creates a new ShellTopPeakStress
Method AddSpringProbe() (p. 710) Creates a new SpringProbe
Method AddStabilizationEnergy() (p. 711) Creates a new StabilizationEnergy
Method AddStrainProbe() (p. 711) Creates a new StrainProbe
Method AddStressFrequencyResponse() (p. 711) Creates a new StressFrequencyResponse
Method AddStressIntensity() (p. 711) Creates a new StressIntensity
Method AddStressPhaseResponse() (p. 711) Creates a new StressPhaseResponse
Method AddStressProbe() (p. 711) Creates a new StressProbe

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
666 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddStressTool() (p. 712) Creates a new StressTool


Method AddStructuralError() (p. 712) Creates a new StructuralError
Method AddStructuralStrainEnergy() (p. 712) Creates a new StructuralStrainEnergy
Method AddTemperature() (p. 712) Creates a new TemperatureResult
Method AddTemperatureProbe() (p. 712) Creates a new TemperatureProbe
Method AddThermalError() (p. 712) Creates a new ThermalError
Method AddThermalStrain() (p. 713) Creates a new DirectionalThermalStrain
Method AddThermalStrainEnergy() (p. 713) Creates a new ThermalStrainEnergy
Method AddTopologyDensity() (p. 713) Creates a new TopologyDensity
Method AddTopologyElementalDensity() (p. 713) Creates a new TopologyElementalDensity
Method AddTorqueProbe() (p. 713) Creates a new TorqueProbe
Method AddTotalAcceleration() (p. 713) Creates a new TotalAcceleration
Method AddTotalAxialForce() (p. 714) Creates a new TotalAxialForce
Method AddTotalBendingMoment() (p. 714) Creates a new TotalBendingMoment
Method AddTotalCurrentDensity() (p. 714) Creates a new TotalCurrentDensity
Method AddTotalDeformation() (p. 714) Creates a new TotalDeformation
Method AddTotalElectricFieldIntensity() (p. 714) Creates a new TotalElectricFieldIntensity
Method AddTotalHeatFlux() (p. 714) Creates a new TotalHeatFlux
Method AddTotalMagneticFieldIntensity() (p. 715) Creates a new TotalMagneticFieldIntensity
Method AddTotalMagneticFluxDensity() (p. 715) Creates a new TotalMagneticFluxDensity
Method AddTotalShearForce() (p. 715) Creates a new TotalShearForce
Method AddTotalTorsionalMoment() (p. 715) Creates a new TotalTorsionalMoment
Method AddTotalVelocity() (p. 715) Creates a new TotalVelocity
Method AddUserDefinedResult() (p. 715) Creates a new UserDefinedResult
Method AddVariableGraph() (p. 716) Creates a new VariableGraph
Method AddVectorAxialForce() (p. 716) Creates a new VectorAxialForce
Method AddVectorBendingMoment() (p. 716) Creates a new VectorBendingMoment
Method AddVectorDeformation() (p. 716) Creates a new VectorDeformation
Method AddVectorHeatFlux() (p. 716) Creates a new VectorHeatFlux
Method AddVectorPrincipalElasticStrain() (p. 716) Creates a new VectorPrincipalElasticStrain
Method AddVectorPrincipalStress() (p. 717) Creates a new VectorPrincipalStress
Method AddVectorShearForce() (p. 717) Creates a new VectorShearForce
Method AddVectorTorsionalMoment() (p. 717) Creates a new VectorTorsionalMoment
Method AddVelocityFrequencyResponse() (p. 717) Creates a new VelocityFrequencyResponse
Method AddVelocityPhaseResponse() (p. 717) Creates a new VelocityPhaseResponse
Method AddVelocityProbe() (p. 717) Creates a new VelocityProbe
Method AddVoltageProbe() (p. 718) Creates a new ElectricVoltageProbe
Method AddVolume() (p. 718) Creates a new Volume
Method AddVolumeProbe() (p. 718) Creates a new VolumeProbe

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 667
Ansys.ACT.Automation.Mechanical Namespace

Method ClearGeneratedData() (p. 718) Run the ClearGeneratedData action.


Method EvaluateAllResults() (p. 718) Run the EvaluateAllResults action.
Method ExtractSolutionStatistics() (p. 718) No details are provided for this entry.
Method GetChildren<ChildrenType>(bool, IList<ChildrenType>) (p. 719) Gets the list of children, filtered by type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 719)
Method GetResults() (p. 719) Gets the Results from the server.
Method OpenSolverFilesDirectory() (p. 720) Run the OpenSolverFilesDirectory action.
Method ReadAnsysResultFile() (p. 720) Run the ANSYS ReadResults action.
Method ReadGivenAnsysResultFile(string, UnitSystemIDType) (p. 720) Run the given ANSYS ReadResults action.///
Method Solve(bool, SolveConfiguration) (p. 720) Run the Solve action.
Method Solve(bool, string) (p. 721) Run the Solve action.

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.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
668 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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; }

EigenSolverType
No details are provided for this entry.

Declaration Syntax
public EigenSolverType EigenSolverType { get; }

ElapsedRunTime
Gets or sets the ElapsedRunTime.

Declaration Syntax
public double ElapsedRunTime { set;get; }

ElapsedTime
No details are provided for this entry.

Declaration Syntax
public double ElapsedTime { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 669
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
670 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 671
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public bool IsEigenSolver { get; }

IsGPUAccelerationRequested
No details are provided for this entry.

Declaration Syntax
public bool IsGPUAccelerationRequested { get; }

IsUnsymmetricMatrixSolve
No details are provided for this entry.

Declaration Syntax
public bool IsUnsymmetricMatrixSolve { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
672 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

License
No details are provided for this entry.

Declaration Syntax
public string License { get; }

LicenseCoresAvailable
No details are provided for this entry.

Declaration Syntax
public int LicenseCoresAvailable { get; }

MainThreadCPUTime
No details are provided for this entry.

Declaration Syntax
public double MainThreadCPUTime { get; }

MaximumRefinementLoops
Gets or sets the MaximumRefinementLoops.

Declaration Syntax
public int MaximumRefinementLoops { set;get; }

MemoryAvailable
No details are provided for this entry.

Declaration Syntax
public double MemoryAvailable { get; }

MemoryUsed
Gets or sets the MemoryUsed.

Declaration Syntax
public double MemoryUsed { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 673
Ansys.ACT.Automation.Mechanical Namespace

MPIType
No details are provided for this entry.

Declaration Syntax
public MPIType MPIType { get; }

MSUPHarmonicAnalysis
No details are provided for this entry.

Declaration Syntax
public bool MSUPHarmonicAnalysis { get; }

Nodes
No details are provided for this entry.

Declaration Syntax
public int Nodes { get; }

NumberofSectors
Gets or sets the NumberofSectors.

Declaration Syntax
public int NumberofSectors { set;get; }

NumCoresAvailable
No details are provided for this entry.

Declaration Syntax
public int NumCoresAvailable { get; }

NumGPURequested
No details are provided for this entry.

Declaration Syntax
public int NumGPURequested { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
674 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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.

Declaration Syntax
public int RefinementDepth { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 675
Ansys.ACT.Automation.Mechanical Namespace

ResultFileSize
Gets the ResultFileSize.

Declaration Syntax
public double ResultFileSize { get; }

SolutionInformation
Gets the SolutionInformation.

Declaration Syntax
public SolutionInformation SolutionInformation { get; }

SolutionUnitSystem
No details are provided for this entry.

Declaration Syntax
public MechanicalUnitSystem SolutionUnitSystem { get; }

SolverData
No details are provided for this entry.

Declaration Syntax
public object SolverData { get; }

SolverType
No details are provided for this entry.

Declaration Syntax
public SolverType SolverType { get; }

Status
Gets the Status.

Declaration Syntax
public SolutionStatusType Status { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
676 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

TabularData
Gets the tabular data of the solution. Use a to get index to each column of the tabular data.

Declaration Syntax
public ITable TabularData { get; }

TimeToCombineDistributedFiles
No details are provided for this entry.

Declaration Syntax
public double TimeToCombineDistributedFiles { get; }

TopologyResult
Gets or sets the TopologyResult.

Declaration Syntax
public DataModelObject TopologyResult { set;get; }

TotalMemoryUsed
No details are provided for this entry.

Declaration Syntax
public double TotalMemoryUsed { get; }

WorkingDir
Gets the WorkingDir.

Declaration Syntax
public string WorkingDir { get; }

AddAccelerationFrequencyResponse()
Creates a new AccelerationFrequencyResponse

Declaration Syntax
public virtual AccelerationFrequencyResponse AddAccelerationFrequencyResponse()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 677
Ansys.ACT.Automation.Mechanical Namespace

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
678 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddAcousticDiffuseSoundTransmissionLoss()
Creates a new AcousticDiffuseSoundTransmissionLoss

Declaration Syntax
public virtual AcousticDiffuseSoundTransmissionLoss AddAcousticDiffuseSoundTransmissionLoss()

AddAcousticDirectionalVelocityResult()
Creates a new AcousticDirectionalVelocityResult

Declaration Syntax
public virtual AcousticDirectionalVelocityResult AddAcousticDirectionalVelocityResult()

AddAcousticFarFieldAWeightedSPL()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldAWeightedSPL()

AddAcousticFarFieldAWeightedSPLMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldAWeightedSPLMic()

AddAcousticFarFieldDirectivity()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldDirectivity()

AddAcousticFarFieldMaximumPressure()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldMaximumPressure()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 679
Ansys.ACT.Automation.Mechanical Namespace

AddAcousticFarFieldMaximumPressureMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldMaximumPressureMic()

AddAcousticFarFieldMaximumScatteredPressure()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldMaximumScatteredPressure()

AddAcousticFarFieldPhase()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldPhase()

AddAcousticFarFieldPhaseMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldPhaseMic()

AddAcousticFarFieldSoundPowerLevel()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldSoundPowerLevel()

AddAcousticFarFieldSoundPowerLevelWaterfallDiagram()
Creates a new AcousticFarFieldSoundPowerLevelWaterfallDiagram

Declaration Syntax
public virtual AcousticFarFieldSoundPowerLevelWaterfallDiagram AddAcousticFarFieldSoundPower-
LevelWaterfallDiagram()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
680 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddAcousticFarFieldSPL()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldSPL()

AddAcousticFarFieldSPLMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldSPLMic()

AddAcousticFarFieldSPLMicWaterfallDiagram()
Creates a new AcousticFarFieldSPLMicWaterfallDiagram

Declaration Syntax
public virtual AcousticFarFieldSPLMicWaterfallDiagram AddAcousticFarFieldSPLMicWaterfallDiagram()

AddAcousticFarFieldTargetStrength()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldTargetStrength()

AddAcousticFrequencyBandAWeightedSPL()
Creates a new AcousticFrequencyBandAWeightedSPL

Declaration Syntax
public virtual AcousticFrequencyBandAWeightedSPL AddAcousticFrequencyBandAWeightedSPL()

AddAcousticFrequencyBandSPL()
Creates a new AcousticFrequencyBandSPL

Declaration Syntax
public virtual AcousticFrequencyBandSPL AddAcousticFrequencyBandSPL()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 681
Ansys.ACT.Automation.Mechanical Namespace

AddAcousticKineticEnergy()
Creates a new AcousticKineticEnergy

Declaration Syntax
public virtual AcousticKineticEnergy AddAcousticKineticEnergy()

AddAcousticKineticEnergyFrequencyResponse()
Creates a new AcousticKineticEnergyFrequencyResponse

Declaration Syntax
public virtual AcousticKineticEnergyFrequencyResponse AddAcousticKineticEnergyFrequencyResponse()

AddAcousticPotentialEnergy()
Creates a new AcousticPotentialEnergy

Declaration Syntax
public virtual AcousticPotentialEnergy AddAcousticPotentialEnergy()

AddAcousticPotentialEnergyFrequencyResponse()
Creates a new AcousticPotentialEnergyFrequencyResponse

Declaration Syntax
public virtual AcousticPotentialEnergyFrequencyResponse AddAcousticPotentialEnergyFrequencyRe-
sponse()

AddAcousticPressureFrequencyResponse()
Creates a new AcousticPressureFrequencyResponse

Declaration Syntax
public virtual AcousticPressureFrequencyResponse AddAcousticPressureFrequencyResponse()

AddAcousticPressureResult()
Creates a new AcousticPressureResult

Declaration Syntax
public virtual AcousticPressureResult AddAcousticPressureResult()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
682 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddAcousticReturnLoss()
Creates a new AcousticReturnLoss

Declaration Syntax
public virtual AcousticReturnLoss AddAcousticReturnLoss()

AddAcousticSoundPressureLevel()
Creates a new AcousticSoundPressureLevel

Declaration Syntax
public virtual AcousticSoundPressureLevel AddAcousticSoundPressureLevel()

AddAcousticSPLFrequencyResponse()
Creates a new AcousticSPLFrequencyResponse

Declaration Syntax
public virtual AcousticSPLFrequencyResponse AddAcousticSPLFrequencyResponse()

AddAcousticTotalVelocityResult()
Creates a new AcousticTotalVelocityResult

Declaration Syntax
public virtual AcousticTotalVelocityResult AddAcousticTotalVelocityResult()

AddAcousticTransmissionLoss()
Creates a new AcousticTransmissionLoss

Declaration Syntax
public virtual AcousticTransmissionLoss AddAcousticTransmissionLoss()

AddAcousticVelocityFrequencyResponse()
Creates a new AcousticVelocityFrequencyResponse

Declaration Syntax
public virtual AcousticVelocityFrequencyResponse AddAcousticVelocityFrequencyResponse()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 683
Ansys.ACT.Automation.Mechanical Namespace

AddAngularAccelerationProbe()
Creates a new AngularAccelerationProbe

Declaration Syntax
public virtual AngularAccelerationProbe AddAngularAccelerationProbe()

AddAngularVelocityProbe()
Creates a new AngularVelocityProbe

Declaration Syntax
public virtual AngularVelocityProbe AddAngularVelocityProbe()

AddBeamProbe()
Creates a new BeamProbe

Declaration Syntax
public virtual BeamProbe AddBeamProbe()

AddBeamTool()
Creates a new BeamTool

Declaration Syntax
public virtual BeamTool AddBeamTool()

AddBearingProbe()
Creates a new BearingProbe

Declaration Syntax
public virtual BearingProbe AddBearingProbe()

AddBendingStressEquivalent()
Creates a new BendingStressEquivalent

Declaration Syntax
public virtual BendingStressEquivalent AddBendingStressEquivalent()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
684 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddBendingStressIntensity()
Creates a new BendingStressIntensity

Declaration Syntax
public virtual BendingStressIntensity AddBendingStressIntensity()

AddBoltPretensionProbe()
Creates a new BoltPretensionProbe

Declaration Syntax
public virtual BoltPretensionProbe AddBoltPretensionProbe()

AddBoltTool()
Creates a new BoltTool

Declaration Syntax
public virtual BoltTool AddBoltTool()

AddCampbellDiagram()
Creates a new CampbellDiagram

Declaration Syntax
public virtual CampbellDiagram AddCampbellDiagram()

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 685
Ansys.ACT.Automation.Mechanical Namespace

AddCompositeCriterion()
Creates a new CompositeCriterion

Declaration Syntax
public virtual CompositeCriterion AddCompositeCriterion()

AddContactTool()
Creates a new ContactTool

Declaration Syntax
public virtual PostContactTool AddContactTool()

AddCurrentDensity()
Creates a new CurrentDensity

Declaration Syntax
public virtual CurrentDensity AddCurrentDensity()

AddCurrentDensityProbe()
Creates a new CurrentDensityProbe

Declaration Syntax
public virtual CurrentDensityProbe AddCurrentDensityProbe()

AddDamageStatus()
Creates a new DamageStatus

Declaration Syntax
public virtual DamageStatus AddDamageStatus()

AddDeformationFrequencyResponse()
Creates a new DeformationFrequencyResponse

Declaration Syntax
public virtual DeformationFrequencyResponse AddDeformationFrequencyResponse()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
686 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddDeformationPhaseResponse()
Creates a new DeformationPhaseResponse

Declaration Syntax
public virtual DeformationPhaseResponse AddDeformationPhaseResponse()

AddDeformationProbe()
Creates a new DeformationProbe

Declaration Syntax
public virtual DeformationProbe AddDeformationProbe()

AddDirectionalAcceleration()
Creates a new DirectionalAcceleration

Declaration Syntax
public virtual DirectionalAcceleration AddDirectionalAcceleration()

AddDirectionalAccelerationPSD()
Creates a new DirectionalAccelerationPSD

Declaration Syntax
public virtual DirectionalAccelerationPSD AddDirectionalAccelerationPSD()

AddDirectionalAccelerationRS()
Creates a new DirectionalAccelerationRS

Declaration Syntax
public virtual DirectionalAccelerationRS AddDirectionalAccelerationRS()

AddDirectionalAxialForce()
Creates a new DirectionalAxialForce

Declaration Syntax
public virtual DirectionalAxialForce AddDirectionalAxialForce()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 687
Ansys.ACT.Automation.Mechanical Namespace

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()

AddDirectionalHeatFlux()
Creates a new DirectionalHeatFlux

Declaration Syntax
public virtual DirectionalHeatFlux AddDirectionalHeatFlux()

AddDirectionalMagneticFieldIntensity()
Creates a new DirectionalMagneticFieldIntensity

Declaration Syntax
public virtual DirectionalMagneticFieldIntensity AddDirectionalMagneticFieldIntensity()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
688 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 689
Ansys.ACT.Automation.Mechanical Namespace

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
690 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 691
Ansys.ACT.Automation.Mechanical Namespace

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
692 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 693
Ansys.ACT.Automation.Mechanical Namespace

AddEquivalentStress()
Creates a new EquivalentStress

Declaration Syntax
public virtual EquivalentStress AddEquivalentStress()

AddEquivalentStressPSD()
Creates a new EquivalentStressPSD

Declaration Syntax
public virtual EquivalentStressPSD AddEquivalentStressPSD()

AddEquivalentStressRS()
Creates a new EquivalentStressRS

Declaration Syntax
public virtual EquivalentStressRS AddEquivalentStressRS()

AddEquivalentTotalStrain()
Creates a new EquivalentTotalStrain

Declaration Syntax
public virtual EquivalentTotalStrain AddEquivalentTotalStrain()

AddExpansionSettings()
Creates a new ExpansionSettings

Declaration Syntax
public virtual ExpansionSettings AddExpansionSettings()

AddFatigueTool()
Creates a new FatigueTool

Declaration Syntax
public virtual FatigueTool AddFatigueTool()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
694 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddFiberCompressiveDamageVariable()
Creates a new FiberCompressiveDamageVariable

Declaration Syntax
public virtual FiberCompressiveDamageVariable AddFiberCompressiveDamageVariable()

AddFiberCompressiveFailureCriterion()
Creates a new FiberCompressiveFailureCriterion

Declaration Syntax
public virtual FiberCompressiveFailureCriterion AddFiberCompressiveFailureCriterion()

AddFiberTensileDamageVariable()
Creates a new FiberTensileDamageVariable

Declaration Syntax
public virtual FiberTensileDamageVariable AddFiberTensileDamageVariable()

AddFiberTensileFailureCriterion()
Creates a new FiberTensileFailureCriterion

Declaration Syntax
public virtual FiberTensileFailureCriterion AddFiberTensileFailureCriterion()

AddFieldIntensityProbe()
Creates a new FieldIntensityProbe

Declaration Syntax
public virtual FieldIntensityProbe AddFieldIntensityProbe()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 695
Ansys.ACT.Automation.Mechanical Namespace

AddFluidFlowRate()
Creates a new FluidFlowRate

Declaration Syntax
public virtual FluidFlowRate AddFluidFlowRate()

AddFluidHeatConductionRate()
Creates a new FluidHeatConductionRate

Declaration Syntax
public virtual FluidHeatConductionRate AddFluidHeatConductionRate()

AddFluidHeatTransportRate()
Creates a new FluidHeatTransportRate

Declaration Syntax
public virtual FluidHeatTransportRate AddFluidHeatTransportRate()

AddFluxDensityProbe()
Creates a new FluxDensityProbe

Declaration Syntax
public virtual FluxDensityProbe AddFluxDensityProbe()

AddFluxLinkage()
Creates a new FluxLinkage

Declaration Syntax
public virtual FluxLinkage AddFluxLinkage()

AddForceReaction()
Creates a new ForceReaction

Declaration Syntax
public virtual ForceReaction AddForceReaction()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
696 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

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.

AddInductance()
Creates a new Inductance

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 697
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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

Declaration Syntax
public virtual LatticeDensity AddLatticeDensity()

AddLatticeElementalDensity()
Creates a new LatticeElementalDensity

Declaration Syntax
public virtual LatticeElementalDensity AddLatticeElementalDensity()

AddLinearizedEquivalentStress()
Creates a new LinearizedEquivalentStress

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
698 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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

Declaration Syntax
public virtual LinearizedMinimumPrincipalStress AddLinearizedMinimumPrincipalStress()

AddLinearizedNormalStress()
Creates a new LinearizedNormalStress

Declaration Syntax
public virtual LinearizedNormalStress AddLinearizedNormalStress()

AddLinearizedShearStress()
Creates a new LinearizedShearStress

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 699
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual LinearizedShearStress AddLinearizedShearStress()

AddLinearizedStressIntensity()
Creates a new LinearizedStressIntensity

Declaration Syntax
public virtual LinearizedStressIntensity AddLinearizedStressIntensity()

AddMagneticCoenergy()
Creates a new MagneticCoenergy

Declaration Syntax
public virtual MagneticCoenergy AddMagneticCoenergy()

AddMagneticDirectionalForces()
Creates a new MagneticDirectionalForces

Declaration Syntax
public virtual MagneticDirectionalForces AddMagneticDirectionalForces()

AddMagneticError()
Creates a new MagneticError

Declaration Syntax
public virtual MagneticError AddMagneticError()

AddMagneticFluxProbe()
Creates a new MagneticFluxProbe

Declaration Syntax
public virtual MagneticFluxProbe AddMagneticFluxProbe()

AddMagneticPotential()
Creates a new MagneticPotential

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
700 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 701
Ansys.ACT.Automation.Mechanical Namespace

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

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
702 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Declaration Syntax
public virtual MembraneStressEquivalent AddMembraneStressEquivalent()

AddMembraneStressIntensity()
Creates a new MembraneStressIntensity

Declaration Syntax
public virtual MembraneStressIntensity AddMembraneStressIntensity()

AddMiddlePrincipalElasticStrain()
Creates a new MiddlePrincipalElasticStrain

Declaration Syntax
public virtual MiddlePrincipalElasticStrain AddMiddlePrincipalElasticStrain()

AddMiddlePrincipalStress()
Creates a new MiddlePrincipalStress

Declaration Syntax
public virtual MiddlePrincipalStress AddMiddlePrincipalStress()

AddMiddlePrincipalThermalStrain()
Creates a new MiddlePrincipalThermalStrain

Declaration Syntax
public virtual MiddlePrincipalThermalStrain AddMiddlePrincipalThermalStrain()

AddMinimumPrincipalElasticStrain()
Creates a new MinimumPrincipalElasticStrain

Declaration Syntax
public virtual MinimumPrincipalElasticStrain AddMinimumPrincipalElasticStrain()

AddMinimumPrincipalStress()
Creates a new MinimumPrincipalStress

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 703
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual MinimumPrincipalStress AddMinimumPrincipalStress()

AddMomentReaction()
Creates a new MomentReaction

Declaration Syntax
public virtual MomentReaction AddMomentReaction()

AddMullinsDamageVariable()
Creates a new MullinsDamageVariable

Declaration Syntax
public virtual MullinsDamageVariable AddMullinsDamageVariable()

AddMullinsMaximumPreviousStrainEnergy()
Creates a new MullinsMaximumPreviousStrainEnergy

Declaration Syntax
public virtual MullinsMaximumPreviousStrainEnergy AddMullinsMaximumPreviousStrainEnergy()

AddNewtonRaphsonResidualForce()
Creates a new NewtonRaphsonResidualForce

Declaration Syntax
public virtual NewtonRaphsonResidualForce AddNewtonRaphsonResidualForce()

AddNewtonRaphsonResidualHeat()
Creates a new NewtonRaphsonResidualHeat

Declaration Syntax
public virtual NewtonRaphsonResidualHeat AddNewtonRaphsonResidualHeat()

AddNewtonRaphsonResidualMoment()
Creates a new NewtonRaphsonResidualMoment

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
704 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

AddNormalGasketPressure()
Creates a new NormalGasketPressure

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 705
Ansys.ACT.Automation.Mechanical Namespace

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()

AddRadiationProbe()
Creates a new RadiationProbe

Declaration Syntax
public virtual RadiationProbe AddRadiationProbe()

AddReactionProbe()
Creates a new ReactionProbe

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
706 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Declaration Syntax
public virtual ReactionProbe AddReactionProbe()

AddResponsePSD()
Creates a new ResponsePSD

Declaration Syntax
public virtual ResponsePSD AddResponsePSD()

AddResponsePSDTool()
Creates a new ResponsePSDTool

Declaration Syntax
public virtual ResponsePSDTool AddResponsePSDTool()

AddRotationProbe()
Creates a new RotationProbe

Declaration Syntax
public virtual RotationProbe AddRotationProbe()

AddShapeFinder()
Creates a new ShapeFinder

Declaration Syntax
public virtual ShapeFinder AddShapeFinder()

AddShapeFinderElemental()
Creates a new ShapeFinderElemental

Declaration Syntax
public virtual ShapeFinderElemental AddShapeFinderElemental()

AddShearDamageVariable()
Creates a new ShearDamageVariable

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 707
Ansys.ACT.Automation.Mechanical Namespace

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()

AddShearMomentDiagramMZ()
Creates a new DirectionalShearMomentDiagram

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
708 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

AddShearMomentDiagramVZ()
Creates a new DirectionalShearMomentDiagram

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 709
Ansys.ACT.Automation.Mechanical Namespace

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()

AddSpringProbe()
Creates a new SpringProbe

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
710 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

AddStressProbe()
Creates a new StressProbe

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 711
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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()

AddThermalError()
Creates a new ThermalError

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
712 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

AddTotalAcceleration()
Creates a new TotalAcceleration

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 713
Ansys.ACT.Automation.Mechanical Namespace

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()

AddTotalHeatFlux()
Creates a new TotalHeatFlux

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
714 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

AddTotalVelocity()
Creates a new TotalVelocity

Declaration Syntax
public virtual TotalVelocity AddTotalVelocity()

AddUserDefinedResult()
Creates a new UserDefinedResult

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 715
Ansys.ACT.Automation.Mechanical Namespace

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()

AddVectorHeatFlux()
Creates a new VectorHeatFlux

Declaration Syntax
public virtual VectorHeatFlux AddVectorHeatFlux()

AddVectorPrincipalElasticStrain()
Creates a new VectorPrincipalElasticStrain

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
716 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

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()

AddVelocityPhaseResponse()
Creates a new VelocityPhaseResponse

Declaration Syntax
public virtual VelocityPhaseResponse AddVelocityPhaseResponse()

AddVelocityProbe()
Creates a new VelocityProbe

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 717
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual VelocityProbe AddVelocityProbe()

AddVoltageProbe()
Creates a new ElectricVoltageProbe

Declaration Syntax
public virtual ElectricVoltageProbe AddVoltageProbe()

AddVolume()
Creates a new Volume

Declaration Syntax
public virtual Volume AddVolume()

AddVolumeProbe()
Creates a new VolumeProbe

Declaration Syntax
public virtual VolumeProbe AddVolumeProbe()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

ExtractSolutionStatistics()
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
718 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Declaration Syntax
public virtual void ExtractSolutionStatistics()

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 719
Ansys.ACT.Automation.Mechanical Namespace

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

unitSystemID(UnitSystemIDType)
The unit system ID as defined in Ansys.Mechanical.DataModel.Enums.UnitSystemIDType

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
720 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

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.

SolutionCombination
Defines a SolutionCombination.

Declaration Syntax
public class SolutionCombination : DataModelObject, IFolderDataModelObject

Table 232: Members

Property Children (p. 723) Gets the list of children.


Property Comments (p. 724) Gets the list of associated comments.
Property DataModelObjectCategory (p. 724) Gets the current DataModelObject's
category.
Property Definition (p. 724) Get the SolutionCombinationDefinition
object. This object contains all the Solution
Combination data like Base Cases, Load
Combinations and Coefficients.
Property Images (p. 724) Gets the list of associated images.
Property InternalObject (p. 724) Gets the internal object. For advanced
usage only.
Property WorksheetType (p. 724) Gets or sets the WorksheetType.
Method AddBeamTool() (p. 725) Creates a new BeamTool
Method AddComment() (p. 725) Creates a new child Comment.
Method AddContactTool() (p. 725) Creates a new ContactTool
Method AddDirectionalAcceleration() (p. 725) Creates a new DirectionalAcceleration
Method AddDirectionalAxialForce() (p. 725) Creates a new DirectionalAxialForce
Method AddDirectionalBendingMoment() (p. 725) Creates a new DirectionalBendingMoment
Method AddDirectionalDeformation() (p. 726) Creates a new DirectionalDeformation

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 721
Ansys.ACT.Automation.Mechanical Namespace

Method AddDirectionalShearForce() (p. 726) Creates a new DirectionalShearForce


Method AddDirectionalTorsionalMoment() (p. 726) Creates a new DirectionalTorsionalMoment
Method AddDirectionalVelocity() (p. 726) Creates a new DirectionalVelocity
Method AddElasticStrainIntensity() (p. 726) Creates a new ElasticStrainIntensity
Method AddEquivalentElasticStrain() (p. 726) Creates a new EquivalentElasticStrain
Method AddEquivalentStress() (p. 727) Creates a new EquivalentStress
Method AddEquivalentTotalStrain() (p. 727) Creates a new EquivalentTotalStrain
Method AddFatigueTool() (p. 727) Creates a new FatigueTool
Method AddImage(string) (p. 727) Creates a new child Image. If a 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. 727) Creates a new LinearizedEquivalentStress
Method AddLinearizedMaximumPrincipalStress() (p. 727) Creates a new
LinearizedMaximumPrincipalStress
Method AddLinearizedMaximumShearStress() (p. 728) Creates a new
LinearizedMaximumShearStress
Method AddLinearizedMiddlePrincipalStress() (p. 728) Creates a new
LinearizedMiddlePrincipalStress
Method AddLinearizedMinimumPrincipalStress() (p. 728) Creates a new
LinearizedMinimumPrincipalStress
Method AddLinearizedNormalStress() (p. 728) Creates a new LinearizedNormalStress
Method AddLinearizedShearStress() (p. 728) Creates a new LinearizedShearStress
Method AddLinearizedStressIntensity() (p. 728) Creates a new LinearizedStressIntensity
Method AddMaximumPrincipalElasticStrain() (p. 729) Creates a new
MaximumPrincipalElasticStrain
Method AddMaximumPrincipalStress() (p. 729) Creates a new MaximumPrincipalStress
Method AddMaximumShearElasticStrain() (p. 729) Creates a new MaximumShearElasticStrain
Method AddMaximumShearStress() (p. 729) Creates a new MaximumShearStress
Method AddMiddlePrincipalElasticStrain() (p. 729) Creates a new MiddlePrincipalElasticStrain
Method AddMiddlePrincipalStress() (p. 729) Creates a new MiddlePrincipalStress
Method AddMinimumPrincipalElasticStrain() (p. 730) Creates a new
MinimumPrincipalElasticStrain
Method AddMinimumPrincipalStress() (p. 730) Creates a new MinimumPrincipalStress
Method AddNormalElasticStrain() (p. 730) Creates a new NormalElasticStrain
Method AddNormalStress() (p. 730) Creates a new NormalStress
Method AddShearElasticStrain() (p. 730) Creates a new ShearElasticStrain
Method AddShearMomentDiagramMSUM() (p. 730) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramMY() (p. 731) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramMZ() (p. 731) Creates a new
DirectionalShearMomentDiagram

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
722 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Method AddShearMomentDiagramUSUM() (p. 731) Creates a new TotalShearMomentDiagram


Method AddShearMomentDiagramUY() (p. 731) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUZ() (p. 731) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVSUM() (p. 731) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramVY() (p. 732) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVZ() (p. 732) Creates a new
DirectionalShearMomentDiagram
Method AddShearStress() (p. 732) Creates a new ShearStress
Method AddStressIntensity() (p. 732) Creates a new StressIntensity
Method AddStressTool() (p. 732) Creates a new StressTool
Method AddTotalAcceleration() (p. 732) Creates a new TotalAcceleration
Method AddTotalAxialForce() (p. 733) Creates a new TotalAxialForce
Method AddTotalBendingMoment() (p. 733) Creates a new TotalBendingMoment
Method AddTotalDeformation() (p. 733) Creates a new TotalDeformation
Method AddTotalShearForce() (p. 733) Creates a new TotalShearForce
Method AddTotalTorsionalMoment() (p. 733) Creates a new TotalTorsionalMoment
Method AddTotalVelocity() (p. 733) Creates a new TotalVelocity
Method AddUserDefinedResult() (p. 734) Creates a new UserDefinedResult
Method AddVectorAxialForce() (p. 734) Creates a new VectorAxialForce
Method AddVectorBendingMoment() (p. 734) Creates a new VectorBendingMoment
Method AddVectorPrincipalElasticStrain() (p. 734) Creates a new VectorPrincipalElasticStrain
Method AddVectorPrincipalStress() (p. 734) Creates a new VectorPrincipalStress
Method AddVectorShearForce() (p. 734) Creates a new VectorShearForce
Method AddVectorTorsionalMoment() (p. 735) Creates a new VectorTorsionalMoment
Method ClearGeneratedData() (p. 735) Run the ClearGeneratedData action.
Method Delete() (p. 735) Run the Delete action.
Method EvaluateAllResults() (p. 735) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 735)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 736)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 723
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Definition
Get the SolutionCombinationDefinition object. This object contains all the Solution Combination data
like Base Cases, Load Combinations and Coefficients.

Declaration Syntax
public SolutionCombinationDefinition Definition { get; }

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; }

WorksheetType
Gets or sets the WorksheetType.

Declaration Syntax
public SolutionCombinationWorksheetType WorksheetType { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
724 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 725
Ansys.ACT.Automation.Mechanical Namespace

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

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
726 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

AddEquivalentStress()
Creates a new EquivalentStress

Declaration Syntax
public virtual EquivalentStress AddEquivalentStress()

AddEquivalentTotalStrain()
Creates a new EquivalentTotalStrain

Declaration Syntax
public virtual EquivalentTotalStrain AddEquivalentTotalStrain()

AddFatigueTool()
Creates a new FatigueTool

Declaration Syntax
public virtual FatigueTool AddFatigueTool()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

AddLinearizedEquivalentStress()
Creates a new LinearizedEquivalentStress

Declaration Syntax
public virtual LinearizedEquivalentStress AddLinearizedEquivalentStress()

AddLinearizedMaximumPrincipalStress()
Creates a new LinearizedMaximumPrincipalStress

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 727
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual LinearizedMaximumPrincipalStress AddLinearizedMaximumPrincipalStress()

AddLinearizedMaximumShearStress()
Creates a new LinearizedMaximumShearStress

Declaration Syntax
public virtual LinearizedMaximumShearStress AddLinearizedMaximumShearStress()

AddLinearizedMiddlePrincipalStress()
Creates a new LinearizedMiddlePrincipalStress

Declaration Syntax
public virtual LinearizedMiddlePrincipalStress AddLinearizedMiddlePrincipalStress()

AddLinearizedMinimumPrincipalStress()
Creates a new LinearizedMinimumPrincipalStress

Declaration Syntax
public virtual LinearizedMinimumPrincipalStress AddLinearizedMinimumPrincipalStress()

AddLinearizedNormalStress()
Creates a new LinearizedNormalStress

Declaration Syntax
public virtual LinearizedNormalStress AddLinearizedNormalStress()

AddLinearizedShearStress()
Creates a new LinearizedShearStress

Declaration Syntax
public virtual LinearizedShearStress AddLinearizedShearStress()

AddLinearizedStressIntensity()
Creates a new LinearizedStressIntensity

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
728 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual LinearizedStressIntensity AddLinearizedStressIntensity()

AddMaximumPrincipalElasticStrain()
Creates a new MaximumPrincipalElasticStrain

Declaration Syntax
public virtual MaximumPrincipalElasticStrain AddMaximumPrincipalElasticStrain()

AddMaximumPrincipalStress()
Creates a new MaximumPrincipalStress

Declaration Syntax
public virtual MaximumPrincipalStress AddMaximumPrincipalStress()

AddMaximumShearElasticStrain()
Creates a new MaximumShearElasticStrain

Declaration Syntax
public virtual MaximumShearElasticStrain AddMaximumShearElasticStrain()

AddMaximumShearStress()
Creates a new MaximumShearStress

Declaration Syntax
public virtual MaximumShearStress AddMaximumShearStress()

AddMiddlePrincipalElasticStrain()
Creates a new MiddlePrincipalElasticStrain

Declaration Syntax
public virtual MiddlePrincipalElasticStrain AddMiddlePrincipalElasticStrain()

AddMiddlePrincipalStress()
Creates a new MiddlePrincipalStress

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 729
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual MiddlePrincipalStress AddMiddlePrincipalStress()

AddMinimumPrincipalElasticStrain()
Creates a new MinimumPrincipalElasticStrain

Declaration Syntax
public virtual MinimumPrincipalElasticStrain AddMinimumPrincipalElasticStrain()

AddMinimumPrincipalStress()
Creates a new MinimumPrincipalStress

Declaration Syntax
public virtual MinimumPrincipalStress AddMinimumPrincipalStress()

AddNormalElasticStrain()
Creates a new NormalElasticStrain

Declaration Syntax
public virtual NormalElasticStrain AddNormalElasticStrain()

AddNormalStress()
Creates a new NormalStress

Declaration Syntax
public virtual NormalStress AddNormalStress()

AddShearElasticStrain()
Creates a new ShearElasticStrain

Declaration Syntax
public virtual ShearElasticStrain AddShearElasticStrain()

AddShearMomentDiagramMSUM()
Creates a new TotalShearMomentDiagram

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
730 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramMSUM()

AddShearMomentDiagramMY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramMY()

AddShearMomentDiagramMZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramMZ()

AddShearMomentDiagramUSUM()
Creates a new TotalShearMomentDiagram

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramUSUM()

AddShearMomentDiagramUY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramUY()

AddShearMomentDiagramUZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramUZ()

AddShearMomentDiagramVSUM()
Creates a new TotalShearMomentDiagram

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 731
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramVSUM()

AddShearMomentDiagramVY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVY()

AddShearMomentDiagramVZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVZ()

AddShearStress()
Creates a new ShearStress

Declaration Syntax
public virtual ShearStress AddShearStress()

AddStressIntensity()
Creates a new StressIntensity

Declaration Syntax
public virtual StressIntensity AddStressIntensity()

AddStressTool()
Creates a new StressTool

Declaration Syntax
public virtual StressTool AddStressTool()

AddTotalAcceleration()
Creates a new TotalAcceleration

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
732 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual TotalAcceleration AddTotalAcceleration()

AddTotalAxialForce()
Creates a new TotalAxialForce

Declaration Syntax
public virtual TotalAxialForce AddTotalAxialForce()

AddTotalBendingMoment()
Creates a new TotalBendingMoment

Declaration Syntax
public virtual TotalBendingMoment AddTotalBendingMoment()

AddTotalDeformation()
Creates a new TotalDeformation

Declaration Syntax
public virtual TotalDeformation AddTotalDeformation()

AddTotalShearForce()
Creates a new TotalShearForce

Declaration Syntax
public virtual TotalShearForce AddTotalShearForce()

AddTotalTorsionalMoment()
Creates a new TotalTorsionalMoment

Declaration Syntax
public virtual TotalTorsionalMoment AddTotalTorsionalMoment()

AddTotalVelocity()
Creates a new TotalVelocity

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 733
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual TotalVelocity AddTotalVelocity()

AddUserDefinedResult()
Creates a new UserDefinedResult

Declaration Syntax
public virtual UserDefinedResult AddUserDefinedResult()

AddVectorAxialForce()
Creates a new VectorAxialForce

Declaration Syntax
public virtual VectorAxialForce AddVectorAxialForce()

AddVectorBendingMoment()
Creates a new VectorBendingMoment

Declaration Syntax
public virtual VectorBendingMoment AddVectorBendingMoment()

AddVectorPrincipalElasticStrain()
Creates a new VectorPrincipalElasticStrain

Declaration Syntax
public virtual VectorPrincipalElasticStrain AddVectorPrincipalElasticStrain()

AddVectorPrincipalStress()
Creates a new VectorPrincipalStress

Declaration Syntax
public virtual VectorPrincipalStress AddVectorPrincipalStress()

AddVectorShearForce()
Creates a new VectorShearForce

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
734 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual VectorShearForce AddVectorShearForce()

AddVectorTorsionalMoment()
Creates a new VectorTorsionalMoment

Declaration Syntax
public virtual VectorTorsionalMoment AddVectorTorsionalMoment()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 735
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 233: Members

Property BaseCaseCount (p. 737) Gets the number of bases cases


Property LoadCombinationCount (p. 737) Gets the number of load combinations
Method AddBaseCase(string, Analysis, Add a BaseCase to the
double) (p. 738) SolutionCombinationDefinition
Method AddLoadCombination(string, Add a LoadCombination to the SolutionCombination
int) (p. 738) Definition
Method DeleteBaseCase(int) (p. 738) Delete a BaseCase from the
SolutionCombinationDefinition
Method DeleteLoadCombination(int) (p. 739) Delete a LoadCombination from the
SolutionCombination Definition
Method Export(string) (p. 739) Export Load Combination Definition data to Comma
Separated Value (CSV) files
Method GetBaseCaseAnalysis(int) (p. 739) Gets the BaseCase Analysis property at given index.
Method GetBaseCaseFrequency(int) (p. 739) Gets the Frequency property from the Base Case at
given index

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
736 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

Method GetBaseCaseName(int) (p. 740) Gets the BaseCase Name property at given index
Method GetBaseCasePhaseAngle(int) (p. 740) Gets the Phase Angle property from the Base Case
at given index
Method GetBaseCaseTime(int) (p. 740) Gets the Time property from the Base Case at given
index
Method GetCoefficient(int, int) (p. 740) Gets the Coefficient property at given
LoadCombination index and BaseCase index
Method GetLoadCombinationName(int) (p. 741) Gets the LoadCombination Name property at given
index
Method GetLoadCombinationType(int) (p. 741) Gets the Load Combination Type property at given
index
Method Import(string) (p. 741) Import Load Combination Definition data from
Comma Separated Value (CSV) files
Method SetBaseCaseAnalysis(int, Sets the BaseCase Analysis property to given index.
Analysis) (p. 742)
Method SetBaseCaseFrequency(int, Sets the Frequency property to the Base Case at
double) (p. 742) given index
Method SetBaseCaseName(int, string) (p. 742) Sets the BaseCase Name property at given index
Method SetBaseCasePhaseAngle(int, Sets the Phase Angle property to the Base Case at
double) (p. 743) given index
Method SetBaseCaseTime(int, double) (p. 743) Sets the Time property to the Base Case at given
index
Method SetCoefficient(int, int, double) (p. 743) Sets the Coefficient property at given
LoadCombination index and BaseCase index
Method SetLoadCombinationName(int, Sets the LoadCombination Name property at given
string) (p. 744) index
Method SetLoadCombinationType(int, Sets the Load Combination Type property at given
int) (p. 744) index

BaseCaseCount
Gets the number of bases cases

Declaration Syntax
public int BaseCaseCount { get; }

LoadCombinationCount
Gets the number of load combinations

Declaration Syntax
public int LoadCombinationCount { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 737
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public void DeleteBaseCase(int index)

Parameters
index(int)
Index to delete Base Case at

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
738 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

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)

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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 739
Ansys.ACT.Automation.Mechanical Namespace

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

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
740 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

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

Declaration Syntax
public int 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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 741
Ansys.ACT.Automation.Mechanical Namespace

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)

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
742 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

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

Declaration Syntax
public void SetBaseCaseTime(int index, double value)

Parameters
index(int)
Index to set Base Case time at

value(double)
Value of time to set

SetCoefficient(int, int, double)


Sets the Coefficient property at given LoadCombination index and BaseCase index

Declaration Syntax
public void SetCoefficient(int LCindex, int BCindex, double value)

Parameters
LCindex(int)
LoadCombination index (row)

BCindex(int)
BaseCase index (column)

value(double)
Coefficient value

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 743
Ansys.ACT.Automation.Mechanical Namespace

SetLoadCombinationName(int, string)
Sets the LoadCombination Name property at given index

Declaration Syntax
public void SetLoadCombinationName(int index, string name)

Parameters
index(int)
Index to set LoadCombination Name at

name(string)
Base Case Name string

SetLoadCombinationType(int, int)
Sets the Load Combination Type property at given index

Declaration Syntax
public void SetLoadCombinationType(int index, int value)

Parameters
index(int)
Index to set Load Combination Type at

value(int)
0 = Linear evaluation, 1 = SRSS evaluation

SolutionInformation
Defines a SolutionInformation.

Declaration Syntax
public class SolutionInformation : DataModelObject, IFolderDataModelObject

Table 234: Members

Property ActivateVisibility (p. 748) Gets or sets the ActivateVisibility.


Property Children (p. 748) Gets the list of children.
Property Comments (p. 748) Gets the list of associated comments.
Property Component (p. 748) Gets or sets the Component.
Property DataModelObjectCategory (p. 748) Gets the current DataModelObject's category.
Property Display (p. 748) Gets or sets the Display.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
744 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Property DisplayFilterDuringSolve (p. 749) Gets or sets the DisplayFilterDuringSolve.


Property DisplayPoints (p. 749) Gets or sets the DisplayPoints.
Property DisplayType (p. 749) Gets or sets the DisplayType.
Property DrawConnectionsAttachedTo (p. 749) Gets or sets the
DrawConnectionsAttachedTo.
Property EnvironmentSelection (p. 749) Gets or Sets the EnvironmentSelection to an
Analysis object.
Property Figures (p. 749) Gets the list of associated figures.
Property IdentifyElementViolations (p. 750) Gets or sets the IdentifyElementViolations.
Property Images (p. 750) Gets the list of associated images.
Property InternalObject (p. 750) Gets the internal object. For advanced usage
only.
Property LineColor (p. 750) Gets or sets the LineColor.
Property LineThickness (p. 750) Gets or sets the LineThickness.
Property ModeNumber (p. 750) Gets or sets the ModeNumber.
Property NewtonRaphsonResiduals (p. 751) Gets or sets the NewtonRaphsonResiduals.
Property ResponseConstraint (p. 751) Gets or sets the ResponseConstraint.
Property ShowHeatResiduals (p. 751) Gets or sets the ShowHeatResiduals.
Property ShowMomentResiduals (p. 751) Gets or sets the ShowMomentResiduals.
Property SolutionOutput (p. 751) Gets or sets the SolutionOutput.
Property StepNumber (p. 751) Gets or sets the StepNumber.
Property StepSelectionMode (p. 752) Gets or sets the StepSelectionMode.
Property SummaryType (p. 752) Gets or sets the SummaryType.
Property UpdateInterval (p. 752) Gets or sets the UpdateInterval.
Property VisibleOnResults (p. 752) Gets or sets the VisibleOnResults.
Method AddChattering() (p. 752) Creates a new ContactChatteringTracker
Method AddClosedPenetration() (p. 752) Creates a new
ContactClosedPenetrationTracker
Method AddComment() (p. 753) Creates a new child Comment.
Method AddContactDepth() (p. 753) Creates a new ContactDepthTracker
Method AddContactEnergy() (p. 753) Creates a new ContactEnergyTracker
Method AddContactForce() (p. 753) Creates a new ContactForceTracker
Method AddContactHeatFlux() (p. 753) Creates a new ContactHeatFluxTracker
Method AddContactingArea() (p. 753) Creates a new ContactingAreaTracker
Method AddContactMaximumNormalStiffness() (p. 754) Creates a new
ContactMaximumNormalStiffnessTracker
Method AddContactMinimumNormalStiffness() (p. 754) Creates a new
ContactMinimumNormalStiffnessTracker
Method AddContactPressure() (p. 754) Creates a new ContactPressureTracker
Method AddDensity() (p. 754) Creates a new DensityTracker
Method AddDirectionalAcceleration() (p. 754) Creates a new DirectionalAccelerationTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 745
Ansys.ACT.Automation.Mechanical Namespace

Method AddDirectionalDeformation() (p. 754) Creates a new DirectionalDeformationTracker


Method AddDirectionalVelocity() (p. 755) Creates a new DirectionalVelocityTracker
Method AddEffectiveStrain() (p. 755) Creates a new EffectiveStrainTracker
Method AddEffectiveStress() (p. 755) Creates a new EffectiveStressTracker
Method AddElasticSlip() (p. 755) Creates a new ContactElasticSlipTracker
Method AddExternalForce() (p. 755) Creates a new ExternalForceTracker
Method AddFigure() (p. 755) Creates a new child Figure.
Method AddFluidPressure() (p. 756) Creates a new ContactFluidPressureTracker
Method AddForceReaction() (p. 756) Creates a new ForceReactionTracker
Method AddFrictionalDissipationEnergy() (p. 756) Creates a new
ContactFrictionalDissipationEnergyTracker
Method AddFrictionalStress() (p. 756) Creates a new ContactFrictionalStressTracker
Method AddGap() (p. 756) Creates a new ContactGapTracker
Method AddHourglassEnergy() (p. 756) Creates a new HourglassEnergyTracker
Method AddImage(string) (p. 757) Creates a new child Image. If a 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. 757) Creates a new InternalEnergyTracker
Method AddKineticEnergy() (p. 757) Creates a new KineticEnergyTracker
Method AddLatticeDensity() (p. 757) Creates a new LatticeDensity
Method AddLatticeElementalDensity() (p. 757) Creates a new LatticeElementalDensity
Method AddMaximumDampingPressure() (p. 757) Creates a new
ContactMaximumDampingPressureTracker
Method AddMaximumGeometricSlidingDistance() (p. 758) Creates a new
ContactMaximumGeometricSlidingDistanceTracker
Method AddMaximumTangentialStiffness() (p. 758) Creates a new
ContactMaximumTangentialStiffnessTracker
Method AddMinimumGeometricSlidingDistance() (p. 758) Creates a new
ContactMinimumGeometricSlidingDistanceTracker
Method AddMinimumTangentialStiffness() (p. 758) Creates a new
ContactMinimumTangentialStiffnessTracker
Method AddMomentReaction() (p. 758) Creates a new MomentReactionTracker
Method AddMomentum() (p. 758) Creates a new MomentumTracker
Method AddNumberContacting() (p. 759) Creates a new NumberContactingTracker
Method AddNumberSticking() (p. 759) Creates a new
ContactNumberStickingTracker
Method AddNumberWithLargePenetration() (p. 759) Creates a new
ContactNumberWithLargePenetrationTracker
Method AddNumberWithTooMuchSliding() (p. 759) Creates a new
ContactNumberWithTooMuchSlidingTracker
Method AddPenetration() (p. 759) Creates a new ContactPenetrationTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
746 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Method AddPlasticWork() (p. 759) Creates a new PlasticWorkTracker


Method AddPosition() (p. 760) Creates a new PositionTracker
Method AddPressure() (p. 760) Creates a new PressureTracker
Method AddResultingPinball() (p. 760) Creates a new
ContactResultingPinballTracker
Method AddSlidingDistance() (p. 760) Creates a new ContactSlidingDistanceTracker
Method AddSlidingIndication() (p. 760) Creates a new
ContactSlidingIndicationTracker
Method AddSpringTrackerDampingForce() (p. 760) Creates a new SpringDampingForceTracker
Method AddSpringTrackerElasticForce() (p. 761) Creates a new SpringElasticForceTracker
Method AddSpringTrackerElongation() (p. 761) Creates a new SpringElongationTracker
Method AddSpringTrackerVelocity() (p. 761) Creates a new SpringVelocityTracker
Method AddStabilizationEnergy() (p. 761) Creates a new
ContactStabilizationEnergyTracker
Method AddStiffnessEnergy() (p. 761) Creates a new StiffnessEnergyTracker
Method AddStrainEnergy() (p. 761) Creates a new ContactStrainEnergyTracker
Method AddTangentialDampingStress() (p. 762) Creates a new
ContactTangentialDampingStressTracker
Method AddTemperature() (p. 762) Creates a new TemperatureTracker
Method AddTopologyDensity() (p. 762) Creates a new TopologyDensity
Method AddTopologyElementalDensity() (p. 762) Creates a new TopologyElementalDensity
Method AddTotalEnergy() (p. 762) Creates a new TotalEnergyTracker
Method AddTotalForceFromContactPressureX() (p. 762) Creates a new
ContactTotalForceFromContactPressureXTracker
Method AddTotalForceFromContactPressureY() (p. 763) Creates a new
ContactTotalForceFromContactPressureYTracker
Method AddTotalForceFromContactPressureZ() (p. 763) Creates a new
ContactTotalForceFromContactPressureZTracker
Method AddTotalForceFromTangentialStressX() (p. 763) Creates a new
ContactTotalForceFromTangentialStressXTracker
Method AddTotalForceFromTangentialStressY() (p. 763) Creates a new
ContactTotalForceFromTangentialStressYTracker
Method AddTotalForceFromTangentialStressZ() (p. 763) Creates a new
ContactTotalForceFromTangentialStressZTracker
Method AddTotalMassAverageVelocity() (p. 763) Creates a new
TotalMassAverageVelocityTracker
Method AddVolumeLossDueToWear() (p. 764) Creates a new
ContactVolumeLossDueToWearTracker
Method EvaluateAllContactTrackers() (p. 764) Run the EvaluateAllContactTrackers action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 764)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 764)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 747
Ansys.ACT.Automation.Mechanical Namespace

Method ImportResultTrackersFromFile(string) (p. 765) Import Result Trackers from File.

ActivateVisibility
Gets or sets the ActivateVisibility.

Declaration Syntax
public bool ActivateVisibility { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Component
Gets or sets the Component.

Declaration Syntax
public OptimizationResponseConstraintComponentType Component { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Display
Gets or sets the Display.

Declaration Syntax
public FEConnectionDisplay Display { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
748 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 749
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
750 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

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; }

ShowHeatResiduals
Gets or sets the ShowHeatResiduals.

Declaration Syntax
public bool ShowHeatResiduals { set;get; }

ShowMomentResiduals
Gets or sets the ShowMomentResiduals.

Declaration Syntax
public bool ShowMomentResiduals { set;get; }

SolutionOutput
Gets or sets the SolutionOutput.

Declaration Syntax
public SolutionOutputType SolutionOutput { set;get; }

StepNumber
Gets or sets the StepNumber.

Declaration Syntax
public int StepNumber { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 751
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public double UpdateInterval { set;get; }

VisibleOnResults
Gets or sets the VisibleOnResults.

Declaration Syntax
public bool VisibleOnResults { set;get; }

AddChattering()
Creates a new ContactChatteringTracker

Declaration Syntax
public virtual ContactChatteringTracker AddChattering()

AddClosedPenetration()
Creates a new ContactClosedPenetrationTracker

Declaration Syntax
public virtual ContactClosedPenetrationTracker AddClosedPenetration()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
752 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddContactDepth()
Creates a new ContactDepthTracker

Declaration Syntax
public virtual ContactDepthTracker AddContactDepth()

AddContactEnergy()
Creates a new ContactEnergyTracker

Declaration Syntax
public virtual ContactEnergyTracker AddContactEnergy()

AddContactForce()
Creates a new ContactForceTracker

Declaration Syntax
public virtual ContactForceTracker AddContactForce()

AddContactHeatFlux()
Creates a new ContactHeatFluxTracker

Declaration Syntax
public virtual ContactHeatFluxTracker AddContactHeatFlux()

AddContactingArea()
Creates a new ContactingAreaTracker

Declaration Syntax
public virtual ContactingAreaTracker AddContactingArea()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 753
Ansys.ACT.Automation.Mechanical Namespace

AddContactMaximumNormalStiffness()
Creates a new ContactMaximumNormalStiffnessTracker

Declaration Syntax
public virtual ContactMaximumNormalStiffnessTracker AddContactMaximumNormalStiffness()

AddContactMinimumNormalStiffness()
Creates a new ContactMinimumNormalStiffnessTracker

Declaration Syntax
public virtual ContactMinimumNormalStiffnessTracker AddContactMinimumNormalStiffness()

AddContactPressure()
Creates a new ContactPressureTracker

Declaration Syntax
public virtual ContactPressureTracker AddContactPressure()

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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
754 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

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

Declaration Syntax
public virtual EffectiveStressTracker AddEffectiveStress()

AddElasticSlip()
Creates a new ContactElasticSlipTracker

Declaration Syntax
public virtual ContactElasticSlipTracker AddElasticSlip()

AddExternalForce()
Creates a new ExternalForceTracker

Declaration Syntax
public virtual ExternalForceTracker AddExternalForce()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 755
Ansys.ACT.Automation.Mechanical Namespace

AddFluidPressure()
Creates a new ContactFluidPressureTracker

Declaration Syntax
public virtual ContactFluidPressureTracker AddFluidPressure()

AddForceReaction()
Creates a new ForceReactionTracker

Declaration Syntax
public virtual ForceReactionTracker AddForceReaction()

AddFrictionalDissipationEnergy()
Creates a new ContactFrictionalDissipationEnergyTracker

Declaration Syntax
public virtual ContactFrictionalDissipationEnergyTracker AddFrictionalDissipationEnergy()

AddFrictionalStress()
Creates a new ContactFrictionalStressTracker

Declaration Syntax
public virtual ContactFrictionalStressTracker AddFrictionalStress()

AddGap()
Creates a new ContactGapTracker

Declaration Syntax
public virtual ContactGapTracker AddGap()

AddHourglassEnergy()
Creates a new HourglassEnergyTracker

Declaration Syntax
public virtual HourglassEnergyTracker AddHourglassEnergy()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
756 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

AddInternalEnergy()
Creates a new InternalEnergyTracker

Declaration Syntax
public virtual InternalEnergyTracker AddInternalEnergy()

AddKineticEnergy()
Creates a new KineticEnergyTracker

Declaration Syntax
public virtual KineticEnergyTracker AddKineticEnergy()

AddLatticeDensity()
Creates a new LatticeDensity

Declaration Syntax
public virtual LatticeDensity AddLatticeDensity()

AddLatticeElementalDensity()
Creates a new LatticeElementalDensity

Declaration Syntax
public virtual LatticeElementalDensity AddLatticeElementalDensity()

AddMaximumDampingPressure()
Creates a new ContactMaximumDampingPressureTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 757
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual 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()

AddMomentum()
Creates a new MomentumTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
758 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual MomentumTracker AddMomentum()

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()

AddPenetration()
Creates a new ContactPenetrationTracker

Declaration Syntax
public virtual ContactPenetrationTracker AddPenetration()

AddPlasticWork()
Creates a new PlasticWorkTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 759
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual 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()

AddSlidingDistance()
Creates a new ContactSlidingDistanceTracker

Declaration Syntax
public virtual ContactSlidingDistanceTracker AddSlidingDistance()

AddSlidingIndication()
Creates a new ContactSlidingIndicationTracker

Declaration Syntax
public virtual ContactSlidingIndicationTracker AddSlidingIndication()

AddSpringTrackerDampingForce()
Creates a new SpringDampingForceTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
760 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual SpringDampingForceTracker AddSpringTrackerDampingForce()

AddSpringTrackerElasticForce()
Creates a new SpringElasticForceTracker

Declaration Syntax
public virtual SpringElasticForceTracker AddSpringTrackerElasticForce()

AddSpringTrackerElongation()
Creates a new SpringElongationTracker

Declaration Syntax
public virtual SpringElongationTracker AddSpringTrackerElongation()

AddSpringTrackerVelocity()
Creates a new SpringVelocityTracker

Declaration Syntax
public virtual SpringVelocityTracker AddSpringTrackerVelocity()

AddStabilizationEnergy()
Creates a new ContactStabilizationEnergyTracker

Declaration Syntax
public virtual ContactStabilizationEnergyTracker AddStabilizationEnergy()

AddStiffnessEnergy()
Creates a new StiffnessEnergyTracker

Declaration Syntax
public virtual StiffnessEnergyTracker AddStiffnessEnergy()

AddStrainEnergy()
Creates a new ContactStrainEnergyTracker

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 761
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactStrainEnergyTracker AddStrainEnergy()

AddTangentialDampingStress()
Creates a new ContactTangentialDampingStressTracker

Declaration Syntax
public virtual ContactTangentialDampingStressTracker AddTangentialDampingStress()

AddTemperature()
Creates a new TemperatureTracker

Declaration Syntax
public virtual TemperatureTracker AddTemperature()

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
762 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual ContactTotalForceFromContactPressureXTracker AddTotalForceFromContactPressureX()

AddTotalForceFromContactPressureY()
Creates a new ContactTotalForceFromContactPressureYTracker

Declaration Syntax
public virtual ContactTotalForceFromContactPressureYTracker AddTotalForceFromContactPressureY()

AddTotalForceFromContactPressureZ()
Creates a new ContactTotalForceFromContactPressureZTracker

Declaration Syntax
public virtual ContactTotalForceFromContactPressureZTracker AddTotalForceFromContactPressureZ()

AddTotalForceFromTangentialStressX()
Creates a new ContactTotalForceFromTangentialStressXTracker

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

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 763
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual TotalMassAverageVelocityTracker AddTotalMassAverageVelocity()

AddVolumeLossDueToWear()
Creates a new ContactVolumeLossDueToWearTracker

Declaration Syntax
public virtual ContactVolumeLossDueToWearTracker AddVolumeLossDueToWear()

EvaluateAllContactTrackers()
Run the EvaluateAllContactTrackers action.

Declaration Syntax
public virtual void EvaluateAllContactTrackers()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
764 of ANSYS, Inc. and its subsidiaries and affiliates.
STL

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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.

STL
Defines a STL.

Declaration Syntax
public class STL : DataModelObject, IFolderDataModelObject

Table 235: Members

Property Children (p. 766) Gets the list of children.


Property Color (p. 766) Gets or sets the Color.
Property Comments (p. 766) Gets the list of associated comments.
Property DataModelObjectCategory (p. 766) Gets the current DataModelObject's category.
Property Figures (p. 766) Gets the list of associated figures.
Property FileName (p. 767) Gets or sets the FileName.
Property Images (p. 767) Gets the list of associated images.
Property InternalObject (p. 767) Gets the internal object. For advanced usage only.
Property LengthUnits (p. 767) Gets or sets the LengthUnits.
Property ShowAlways (p. 767) Gets or sets the ShowAlways.
Property Statistics (p. 767) Gets the Statistics.
Property Suppressed (p. 768) Gets or sets the Suppressed.
Property TranslateX (p. 768) Gets or sets the TranslateX.
Property TranslateY (p. 768) Gets or sets the TranslateY.
Property TranslateZ (p. 768) Gets or sets the TranslateZ.
Method AddComment() (p. 768) Creates a new child Comment.
Method AddFigure() (p. 768) Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 765
Ansys.ACT.Automation.Mechanical Namespace

Method AddImage(string) (p. 769) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 769) Run the Delete action.
Method ExportStl(string, Progress) (p. 769) Export STL data.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 769)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 770)
Method ImportSTL() (p. 770) Run the ImportSTL action.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Color
Gets or sets the Color.

Declaration Syntax
public int Color { 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
766 of ANSYS, Inc. and its subsidiaries and affiliates.
STL

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FileName
Gets or sets the FileName.

Declaration Syntax
public string FileName { 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 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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 767
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int Statistics { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TranslateX
Gets or sets the TranslateX.

Declaration Syntax
public double TranslateX { set;get; }

TranslateY
Gets or sets the TranslateY.

Declaration Syntax
public double TranslateY { set;get; }

TranslateZ
Gets or sets the TranslateZ.

Declaration Syntax
public double TranslateZ { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
768 of ANSYS, Inc. and its subsidiaries and affiliates.
STL

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()

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.

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 769
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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()

Surface
Defines a Surface.

Declaration Syntax
public class Surface : DataModelObject, ISelectionInfo, IFolderDataModelObject

Table 236: Members

Property Children (p. 771) Gets the list of children.


Property Comments (p. 771) Gets the list of associated comments.
Property CoordinateSystem (p. 771) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 771) Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
770 of ANSYS, Inc. and its subsidiaries and affiliates.
Surface

Property Figures (p. 772) Gets the list of associated figures.


Property Images (p. 772) Gets the list of associated images.
Property InternalObject (p. 772) Gets the internal object. For advanced usage only.
Property Suppressed (p. 772) Gets or sets the Suppressed.
Method AddComment() (p. 772) Creates a new child Comment.
Method AddFigure() (p. 772) Creates a new child Figure.
Method AddImage(string) (p. 773) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 773) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 773)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 773)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 771
Ansys.ACT.Automation.Mechanical Namespace

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSurfaceAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
772 of ANSYS, Inc. and its subsidiaries and affiliates.
Surface

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 773
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject, IFolderDataModelObject

Table 237: Members

Property Children (p. 775) Gets the list of children.


Property Comments (p. 775) Gets the list of associated comments.
Property CoordinateSystem (p. 775) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 775) Gets the current DataModelObject's category.
Property Figures (p. 775) Gets the list of associated figures.
Property Images (p. 775) Gets the list of associated images.
Property InternalObject (p. 776) Gets the internal object. For advanced usage only.
Property Location (p. 776) Gets or sets the Location.
Property Material (p. 776) Gets or sets the Material.
Property Suppressed (p. 776) Gets or sets the Suppressed.
Property SurfaceCoatingStiffnessBehavior (p. 776) Gets or sets the SurfaceCoatingStiffnessBehavior.
Property Thickness (p. 776) Gets or sets the Thickness.
Method AddComment() (p. 777) Creates a new child Comment.
Method AddFigure() (p. 777) Creates a new child Figure.
Method AddImage(string) (p. 777) Creates a new child Image. If a 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. 777) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 777)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 778)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
774 of ANSYS, Inc. and its subsidiaries and affiliates.
SurfaceCoating

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 775
Ansys.ACT.Automation.Mechanical Namespace

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
776 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 777
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 : DataModelObject, IFolderDataModelObject

Table 238: Members

Property Children (p. 779) Gets the list of children.


Property Comments (p. 779) Gets the list of associated comments.
Property DataModelObjectCategory (p. 779) Gets the current DataModelObject's category.
Property Figures (p. 779) Gets the list of associated figures.
Property Images (p. 780) Gets the list of associated images.
Property InternalObject (p. 780) Gets the internal object. For advanced usage only.
Method AddComment() (p. 780) Creates a new child Comment.
Method AddCyclicRegion() (p. 780) Creates a new CyclicRegion
Method AddFigure() (p. 780) Creates a new child Figure.
Method AddGeneralAxisymmetric() (p. 780) Creates a new GeneralAxisymmetric

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
778 of ANSYS, Inc. and its subsidiaries and affiliates.
Symmetry

Method AddImage(string) (p. 781) Creates a new child Image. If a 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. 781) Creates a new SymmetryRegion
Method AddPeriodicRegion() (p. 781) Creates a new PeriodicRegion
Method AddPreMeshedCyclicRegion() (p. 781) Creates a new PreMeshedCyclicRegion
Method AddSymmetryRegion() (p. 781) Creates a new SymmetryRegion
Method Delete() (p. 781) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 782)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 782)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 779
Ansys.ACT.Automation.Mechanical Namespace

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()

AddGeneralAxisymmetric()
Creates a new GeneralAxisymmetric

Declaration Syntax
public virtual GeneralAxisymmetric AddGeneralAxisymmetric()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
780 of ANSYS, Inc. and its subsidiaries and affiliates.
Symmetry

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()

AddSymmetryRegion()
Creates a new SymmetryRegion

Declaration Syntax
public virtual SymmetryRegion AddSymmetryRegion()

Delete()
Run the Delete action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 781
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

SymmetryGeneral
Defines a SymmetryGeneral.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
782 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryGeneral

Declaration Syntax
public class SymmetryGeneral : DataModelObject, IFolderDataModelObject

Table 239: Members

Property Children (p. 783) Gets the list of children.


Property Comments (p. 783) Gets the list of associated comments.
Property CoordinateSystem (p. 784) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 784) Gets the current DataModelObject's category.
Property Figures (p. 784) Gets the list of associated figures.
Property HighBoundaryLocation (p. 784) Gets or sets the HighBoundaryLocation.
Property Images (p. 784) Gets the list of associated images.
Property InternalObject (p. 784) Gets the internal object. For advanced usage only.
Property Location (p. 785) Gets or sets the Location.
Property LowBoundaryLocation (p. 785) Gets or sets the LowBoundaryLocation.
Property ScopeMode (p. 785) Gets the ScopeMode.
Property Suppressed (p. 785) Gets or sets the Suppressed.
Method AddComment() (p. 785) Creates a new child Comment.
Method AddFigure() (p. 785) Creates a new child Figure.
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 Delete() (p. 786) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 786)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 786)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 783
Ansys.ACT.Automation.Mechanical Namespace

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

HighBoundaryLocation
Gets or sets the HighBoundaryLocation.

Declaration Syntax
public ISelectionInfo HighBoundaryLocation { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
784 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryGeneral

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

LowBoundaryLocation
Gets or sets the LowBoundaryLocation.

Declaration Syntax
public ISelectionInfo LowBoundaryLocation { set;get; }

ScopeMode
Gets the ScopeMode.

Declaration Syntax
public AutomaticOrManual ScopeMode { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 785
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
786 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryManufacturingConstraint

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 240: Members

Property Axis (p. 787) Gets or sets the Axis.


Property Children (p. 436) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 435).)
Property CoordinateSystem (p. 788) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 788)Gets the current DataModelObject's
category.
Property InternalObject (p. 788) Gets the internal object. For advanced usage
only.
Property Location (p. 788) Gets or sets the Location.
Property ScopingMethod (p. 788) Gets or sets the ScopingMethod.
Property Selection (p. 436) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 435).)
Property Suppressed (p. 437) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 435).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 787
Ansys.ACT.Automation.Mechanical Namespace

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; }

SymmetryRegion
Defines a SymmetryRegion.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
788 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryRegion

Declaration Syntax
public class SymmetryRegion : SymmetryGeneral

Table 241: Members

Property Behavior (p. 789) Gets or sets the Behavior.


Property Children (p. 783) Gets the list of children.

(Inherited from SymmetryGeneral (p. 782).)


Property Comments (p. 783) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 782).)


Property CoordinateSystem (p. 784) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 782).)


Property DataModelObjectCategory (p. 790)Gets the current DataModelObject's
category.
Property Figures (p. 784) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 782).)


Property HighBoundaryLocation (p. 784) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property Images (p. 784) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 782).)


Property InternalObject (p. 790) Gets the internal object. For advanced usage
only.
Property LinearShift (p. 790) Gets or sets the LinearShift.
Property Location (p. 790) Gets or sets the Location.
Property LowBoundaryLocation (p. 785) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 782).)


Property PeriodicityDirection (p. 790) Gets or sets the PeriodicityDirection.
Property ScopeMode (p. 785) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 782).)


Property Suppressed (p. 785) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 782).)


Property SymmetryNormal (p. 790) Gets or sets the SymmetryNormal.
Property Type (p. 791) Gets or sets the Type.
Method FlipHighLow() (p. 791) Flips the High and Low Boundaries.

Behavior
Gets or sets the Behavior.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 789
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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; }

SymmetryNormal
Gets or sets the SymmetryNormal.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
790 of ANSYS, Inc. and its subsidiaries and affiliates.
TemperatureConstraint

Declaration Syntax
public SymmetryNormalType SymmetryNormal { set;get; }

Type
Gets or sets the Type.

Declaration Syntax
public SymmetryRegionType Type { set;get; }

FlipHighLow()
Flips the High and Low Boundaries.

Declaration Syntax
public virtual void FlipHighLow()

TemperatureConstraint
Defines a TemperatureConstraint.

Declaration Syntax
public class TemperatureConstraint : ResponseConstraint

Table 242: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 792)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 792) Gets the internal object. For advanced usage only.
Property Location (p. 792) Gets or sets the Location.
Property ScopingMethod (p. 792) Gets or sets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)


Property TemperatureAbsMax (p. 792) Gets or sets the TemperatureAbsMax.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 791
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

TemperatureAbsMax
Gets or sets the TemperatureAbsMax.

Declaration Syntax
public Field TemperatureAbsMax { get; }

ThermalPointMass
Defines a ThermalPointMass.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
792 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalPointMass

Declaration Syntax
public class ThermalPointMass : GenericPointMass

Table 243: Members

Property AppliedBy (p. 793) Gets or sets the AppliedBy.


Property Behavior (p. 794) Gets or sets the Behavior.
Property Children (p. 354) Gets the list of children.

(Inherited from GenericPointMass (p. 353).)


Property Comments (p. 354) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 353).)


Property CoordinateSystem (p. 794) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 794)Gets the current DataModelObject's category.
Property Figures (p. 355) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 353).)


Property Images (p. 355) Gets the list of associated images.

(Inherited from GenericPointMass (p. 353).)


Property InternalObject (p. 794) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 355) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 353).)


Property Location (p. 355) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 353).)


Property PinballRegion (p. 794) Gets or sets the PinballRegion.
Property RemotePoint (p. 355) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 353).)


Property Suppressed (p. 794) Gets or sets the Suppressed.
Property ThermalCapacitance (p. 795) Gets or sets the ThermalCapacitance.
Method PromoteToRemotePoint() (p. 795) Run the PromoteToRemotePoint action.

AppliedBy
Gets or sets the AppliedBy.

Declaration Syntax
public RemoteApplicationType AppliedBy { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 793
Ansys.ACT.Automation.Mechanical Namespace

Behavior
Gets or sets the Behavior.

Declaration Syntax
public ThermalPointMassBehavior Behavior { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

PinballRegion
Gets or sets the PinballRegion.

Declaration Syntax
public Quantity PinballRegion { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
794 of ANSYS, Inc. and its subsidiaries and affiliates.
Thickness

ThermalCapacitance
Gets or sets the ThermalCapacitance.

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 : DataModelObject, IFolderDataModelObject

Table 244: Members

Property Children (p. 796) Gets the list of children.


Property Comments (p. 796) Gets the list of associated comments.
Property DataModelObjectCategory (p. 796) Gets the current DataModelObject's category.
Property Figures (p. 796) Gets the list of associated figures.
Property Images (p. 796) Gets the list of associated images.
Property IndependentVariable (p. 797) Gets or sets the IndependentVariable.
Property InternalObject (p. 797) Gets the internal object. For advanced usage only.
Property Location (p. 797) Gets or sets the Location.
Property NumberOfSegments (p. 797) Gets or sets the NumberOfSegments.
Property OffsetType (p. 797) Gets or sets the OffsetType.
Property RangeMaximum (p. 797) Gets or sets the RangeMaximum.
Property RangeMinimum (p. 798) Gets or sets the RangeMinimum.
Property ScopeMode (p. 798) Gets the ScopeMode.
Property Suppressed (p. 798) Gets or sets the Suppressed.
Property ThicknessField (p. 798) Gets or sets the ThicknessField.
Property XYZFunctionCoordinateSystem (p. 798) Gets or sets the XYZFunctionCoordinateSystem.
Method AddComment() (p. 798) Creates a new child Comment.
Method AddFigure() (p. 799) Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 795
Ansys.ACT.Automation.Mechanical Namespace

Method AddImage(string) (p. 799) Creates a new child Image. If a 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. 799) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 799)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 800)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
796 of ANSYS, Inc. and its subsidiaries and affiliates.
Thickness

Declaration Syntax
public IEnumerable<Image> Images { get; }

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; }

NumberOfSegments
Gets or sets the NumberOfSegments.

Declaration Syntax
public int NumberOfSegments { set;get; }

OffsetType
Gets or sets the OffsetType.

Declaration Syntax
public ShellOffsetType OffsetType { set;get; }

RangeMaximum
Gets or sets the RangeMaximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 797
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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; }

AddComment()
Creates a new child Comment.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
798 of ANSYS, Inc. and its subsidiaries and affiliates.
Thickness

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.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 799
Ansys.ACT.Automation.Mechanical Namespace

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 245: Members

Property ActiveObjects (p. 801) Gets a list of all selected objects.


Property AllObjects (p. 801) Gets a list of all objects available in the tree.
Property CurrentFilter (p. 801) Gets the current filter applied on the tree.
Property CurrentSearchGraphics (p. 801) Gets the current visibility.
Property CurrentSearchState (p. 802) Gets the current search state.
Property CurrentSearchString (p. 802) Gets the current search string (name/tag).
Property FirstActiveObject (p. 802) Gets the first object selected in the tree.
Property GroupingFoldersVisible (p. 802) Controls whether or not group folders are visible.
Method Activate(IEnumerable<DataModelObject>) (p. 802) Multi-selects a list of objects in the tree.
Method ClearFilter() (p. 803) Clears the current filter.
Method ClearSort() (p. 803) 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. 803)
Method Find(string, Func<DataModelObject, bool>, Gets a list of all objects with the specified parameters.
string, ObjectState) (p. 804)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
800 of ANSYS, Inc. and its subsidiaries and affiliates.
Tree

Method GetPathToFirstActiveObject() (p. 804) Gets the full path that needs to be typed in order to go to
Method Group(IEnumerable<DataModelObject>) (p. 804) Groups a list of objects together.
Method IsSorted() (p. 805) Checks if the tree is currently sorted alphabetically.
Method Refresh() (p. 805) Refreshes the tree.
Method Sort(SortingType, bool) (p. 805) 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


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. 806)

ActiveObjects
Gets a list of all selected objects.

Declaration Syntax
public IList<DataModelObject> ActiveObjects { get; }

AllObjects
Gets a list of all objects available in the tree.

Declaration Syntax
public IList<DataModelObject> AllObjects { get; }

CurrentFilter
Gets the current filter applied on the tree.

Declaration Syntax
public DSTreeSearchType CurrentFilter { get; }

CurrentSearchGraphics
Gets the current visibility.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 801
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public 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 DataModelObject FirstActiveObject { get; }

GroupingFoldersVisible
Controls whether or not group folders are visible.

Declaration Syntax
public bool GroupingFoldersVisible { set;get; }

Activate(IEnumerable<DataModelObject>)
Multi-selects a list of objects in the tree.

Declaration Syntax
public void Activate(IEnumerable<DataModelObject> dataModelObjects)

Parameters
dataModelObjects(IEnumerable<DataModelObject>)
List of objects to select.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
802 of ANSYS, Inc. and its subsidiaries and affiliates.
Tree

ClearFilter()
Clears the current filter.

Declaration Syntax
public void ClearFilter()

ClearSort()
Clears the current sort.

Declaration Syntax
public void ClearSort()

Filter(string, string, ObjectState, VisibilityType, TreeFilterObjectClass, Co-


ordinateSystem, string, Analysis, TreeFilterScopingType, TreeFilterObject-
State)
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").

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 803
Ansys.ACT.Automation.Mechanical Namespace

environment(Analysis)
Filter by Environment.

scoping(TreeFilterScopingType)
Filter by Scoping.

filterState(TreeFilterObjectState)
Filter by object State.

Find(string, Func<DataModelObject, bool>, string, ObjectState)


Gets a list of all objects with the specified parameters.

Declaration Syntax
public IEnumerable<DataModelObject> Find(string name, Func<DataModelObject, bool> func, string
tag, ObjectState state)

Parameters
name(string)
The object's name.

func(Func<DataModelObject, 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(IEnumerable<DataModelObject>)
Groups a list of objects together.

Declaration Syntax
public TreeGroupingFolder Group(IEnumerable<DataModelObject> dataModelObjects)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
804 of ANSYS, Inc. and its subsidiaries and affiliates.
Tree

Parameters
dataModelObjects(IEnumerable<DataModelObject>)
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)

Parameters
type(SortingType)
No details are provided for this entry.

reverse(bool)
No details are provided for this entry.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 805
Ansys.ACT.Automation.Mechanical Namespace

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 : DataModelObject, IFolderDataModelObject

Table 246: Members

Property Children (p. 806) Gets the list of children.


Property ChildrenInGroup (p. 806) Gets the ChildrenInGroup.
Property DataModelObjectCategory (p. 807) Gets the current DataModelObject's
category.
Property InternalObject (p. 807) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 807) Gets or sets the Suppressed.
Method DeleteTreeGroupAndChildren() (p. 807) Run the DeleteTreeGroupAndChildren
action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 807)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 808)
Method Ungroup() (p. 808) Run the Ungroup action.

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

ChildrenInGroup
Gets the ChildrenInGroup.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
806 of ANSYS, Inc. and its subsidiaries and affiliates.
TreeGroupingFolder

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.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 807
Ansys.ACT.Automation.Mechanical Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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()

VirtualCell
Defines a VirtualCell.

Declaration Syntax
public class VirtualCell : DataModelObject, IFolderDataModelObject

Table 247: Members

Property Children (p. 809) Gets the list of children.


Property Comments (p. 809) Gets the list of associated comments.
Property DataModelObjectCategory (p. 809) Gets the current DataModelObject's category.
Property Figures (p. 809) Gets the list of associated figures.
Property Geometry (p. 810) Gets the Geometry.
Property Images (p. 810) Gets the list of associated images.
Property InternalObject (p. 810) Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
808 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualCell

Property ProjectToUnderlyingGeometry (p. 810) Gets or sets the ProjectToUnderlyingGeometry.


Property VTClass (p. 810) Gets the VTClass.
Method AddComment() (p. 810) Creates a new child Comment.
Method AddFigure() (p. 811) Creates a new child Figure.
Method AddImage(string) (p. 811) Creates a new child Image. If a 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. 811) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 811)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 811)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 809
Ansys.ACT.Automation.Mechanical Namespace

Geometry
Gets the Geometry.

Declaration Syntax
public ISelectionInfo Geometry { 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 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()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
810 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualCell

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.

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<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 811
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 248: Members

Property AspectRatio (p. 813) Gets or sets the AspectRatio.


Property AutomaticBehavior (p. 813) Gets or sets the Behavior when Method
is set to "Automatic".
Property Children (p. 813) Gets the list of children.
Property Comments (p. 814) Gets the list of associated comments.
Property ContactAngle (p. 814) Gets or sets the ContactAngle.
Property CustomFeatureAngle (p. 814) Gets or sets the CustomFeatureAngle.
Property DataModelObjectCategory (p. 814) Gets the current DataModelObject's
category.
Property EdgeAngle (p. 814) Gets or sets the EdgeAngle.
Property Figures (p. 814) Gets the list of associated figures.
Property GaussAngle (p. 815) Gets or sets the GaussAngle.
Property GenerateOnUpdate (p. 815) Gets or sets the GenerateOnUpdate.
Property Images (p. 815) Gets the list of associated images.
Property InternalObject (p. 815) Gets the internal object. For advanced
usage only.
Property LockPositionOfDependentEdgeSplits (p. 815) Gets or sets the
LockPositionOfDependentEdgeSplits.
Property MergeFaceEdges (p. 815) Gets or sets the MergeFaceEdges.
Property Method (p. 816) Gets or sets the Method.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
812 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

Property RepairBehavior (p. 816) Gets or sets the Behavior when Method
is set to "Repair".
Property SharedBoundaryRatio (p. 816) Gets or sets the SharedBoundaryRatio.
Property SimplifyFaces (p. 816) Gets or sets the SimplifyFaces.
Property VirtualEdges (p. 816) Gets the VirtualEdges.
Property VirtualEntities (p. 816) Gets the VirtualEntities.
Property VirtualFaces (p. 817) Gets the VirtualFaces.
Property VirtualHardVertex (p. 817) Gets the VirtualHardVertex.
Property VirtualSplitEdges (p. 817) Gets the VirtualSplitEdges.
Property VirtualSplitFaces (p. 817) Gets the VirtualSplitFaces.
Method AddComment() (p. 817) Creates a new child Comment.
Method AddFigure() (p. 817) Creates a new child Figure.
Method AddImage(string) (p. 818) Creates a new child Image. If a 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. 818) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 818)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 818)
Method GetVirtualCellFromSelection(ISelectionInfo) (p. 819)Gets the Virtual Cell from the selection.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 813
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IList<DataModelObject> 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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
814 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

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.

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; }

MergeFaceEdges
Gets or sets the MergeFaceEdges.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 815
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public YesNoType MergeFaceEdges { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public VirtualCellGroupMethodType Method { 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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
816 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 817
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
818 of ANSYS, Inc. and its subsidiaries and affiliates.
VolumeConstraint

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

GetVirtualCellFromSelection(ISelectionInfo)
Gets the Virtual Cell from the selection.

Declaration Syntax
public virtual VirtualCell GetVirtualCellFromSelection(ISelectionInfo currentSelection)

Parameters
currentSelection(ISelectionInfo)
Selection used to find the associated Virtual Cell.

VolumeConstraint
Defines a VolumeConstraint.

Declaration Syntax
public class VolumeConstraint : ResponseConstraint

Table 249: Members

Property Children (p. 626) Gets the list of children.

(Inherited from ResponseConstraint (p. 625).)


Property DataModelObjectCategory (p. 820) Gets the current DataModelObject's category.
Property DefineBy (p. 820) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 626) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 625).)


Property InternalObject (p. 820) Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 819
Ansys.ACT.Automation.Mechanical Namespace

Property PercentageToRetain (p. 820) Gets or sets the PercentageToRetain.


Property PercentageToRetainMax (p. 820) Gets or sets the PercentageToRetainMax.
Property PercentageToRetainMin (p. 821) Gets or sets the PercentageToRetainMin.
Property ScopingMethod (p. 821) Gets the ScopingMethod.
Property Suppressed (p. 626) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 625).)

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; }

PercentageToRetain
Gets or sets the PercentageToRetain.

Declaration Syntax
public int PercentageToRetain { set;get; }

PercentageToRetainMax
Gets or sets the PercentageToRetainMax.

Declaration Syntax
public int PercentageToRetainMax { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
820 of ANSYS, Inc. and its subsidiaries and affiliates.
Worksheet

PercentageToRetainMin
Gets or sets the PercentageToRetainMin.

Declaration Syntax
public int PercentageToRetainMin { set;get; }

ScopingMethod
Gets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

Worksheet
No details are provided for this entry.

Declaration Syntax
public abstract class Worksheet : IWorksheet

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 821
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
822 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.MeshControls Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.MeshControls

Table 250: Members

AutomaticMethod (p. 823) Defines a


AutomaticMethod.
ContactSizing (p. 837) Defines a
ContactSizing.
FaceMeshing (p. 838) Defines a
FaceMeshing.
Inflation (p. 841) Defines a Inflation.
MatchControl (p. 844) Defines a
MatchControl.
Mesh (p. 847) Defines a Mesh.
MeshControl (p. 870) Defines a
MeshControl.
Pinch (p. 873) Defines a Pinch.
Refinement (p. 875) Defines a Refinement.
Relevance (p. 876) Defines a Relevance.
Sizing (p. 878) Defines a Sizing.

AutomaticMethod
Defines a AutomaticMethod.

Declaration Syntax
public class AutomaticMethod : MeshControl

Table 251: Members

Property Active (p. 826) Gets the Active.


Property AggressiveInflateOption (p. 826) Gets or sets the AggressiveInflateOption.
Property AggressiveTetImprovement (p. 826) Gets or sets the
AggressiveTetImprovement.
Property Algorithm (p. 826) Gets or sets the Algorithm.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 823
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Property ApproximativeNumberOfElementsPerPart (p. 826) Gets or sets the


ApproximativeNumberOfElementsPerPart.
Property BFCartSubType (p. 826) Gets the BFCartSubType.
Property BFCartTolerance (p. 827) Gets the BFCartTolerance.
Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)


Property ConstrainBoundary (p. 827) Gets or sets the ConstrainBoundary.
Property ControlMessages (p. 827) Gets the ControlMessages.
Property CoordinateSystem (p. 827) Gets or sets the CoordinateSystem.
Property CornerAngle (p. 827) Gets or sets the CornerAngle.
Property CurvatureNormalAngle (p. 827) Gets or sets the CurvatureNormalAngle.
Property DataModelObjectCategory (p. 828) Gets the current DataModelObject's
category.
Property DefeatureLayerVolume (p. 828) Gets or sets the DefeatureLayerVolume.
Property DefeaturingTolerance (p. 828) Gets or sets the DefeaturingTolerance.
Property DefinedBy (p. 828) Gets or sets the DefinedBy.
Property ElementMidsideNodes ***OBSOLETE*** Use the Gets or sets the ElementMidsideNodes.
ElementOrder property instead. (p. 828)
Property ElementOption (p. 828) Gets or sets the ElementOption.
Property ElementOrder (p. 829) Gets or sets the ElementOrder.
Property FeatureAngle (p. 829) Gets or sets the FeatureAngle.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property FreeFaceMeshType (p. 829) Gets or sets the FreeFaceMeshType.
Property FreeMeshType (p. 829) Gets or sets the FreeMeshType.
Property GenerateLayersUsingFacets (p. 829) Gets or sets the
GenerateLayersUsingFacets.
Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InflateRelativeTolerance (p. 829) Gets or sets the InflateRelativeTolerance.
Property InternalObject (p. 830) Gets the internal object. For advanced
usage only.
Property KeyPointsSelection (p. 830) Gets or sets the KeyPointsSelection.
Property LayerHeight (p. 830) Gets or sets the LayerHeight.
Property LayerStart (p. 830) Gets or sets the LayerStart.
Property Location (p. 830) Gets or sets the Location.
Property MappedMeshType (p. 830) Gets or sets the MappedMeshType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
824 of ANSYS, Inc. and its subsidiaries and affiliates.
AutomaticMethod

Property MatchMeshWherePossible (p. 831) Gets or sets the


MatchMeshWherePossible.
Property MaximumElementSize (p. 831) Gets or sets the MaximumElementSize.
Property MeshBasedDefeaturing (p. 831) Gets or sets the MeshBasedDefeaturing.
Property MeshInCenter (p. 831) Gets or sets the MeshInCenter.
Property Method (p. 831) Gets or sets the Method.
Property MinimumEdgeLength (p. 831) Gets the MinimumEdgeLength.
Property MinimumSizeLimit (p. 832) Gets or sets the MinimumSizeLimit.
Property NumberOfCellsAcrossGap (p. 832) Gets or sets the NumberOfCellsAcrossGap.
Property OverlappingAngle (p. 832) Gets or sets the OverlappingAngle.
Property PreserveBoundaries (p. 832) Gets or sets the PreserveBoundaries.
Property ProjectCornersToTop (p. 832) Gets or sets the ProjectCornersToTop.
Property ProjectInConstantZPlane (p. 832) Gets or sets the ProjectInConstantZPlane.
Property ProjectionFactor (p. 833) Gets or sets the ProjectionFactor.
Property Refinement (p. 833) Gets or sets the Refinement.
Property RelativeTolerance (p. 833) Gets or sets the PrimeRelativeTolerance.
Property RepairFacets (p. 833) Gets or sets the RepairFacets.
Property ReuseBlocking (p. 833) Gets or sets the ReuseBlocking.
Property SlicerFeatureAngle (p. 833) Gets or sets the SlicerFeatureAngle.
Property SliverTriangleHeight (p. 834) Gets or sets the SliverTriangleHeight.
Property SmoothTransition (p. 834) Gets or sets the SmoothTransition.
Property SourceLocation (p. 834) Gets or sets the SourceLocation.
Property SourceTargetSelection (p. 834) Gets or sets the SourceTargetSelection.
Property SpacingOption (p. 834) Gets or sets the SpacingOption.
Property StretchFactorX (p. 834) Gets or sets the StretchFactorX.
Property StretchFactorY (p. 835) Gets or sets the StretchFactorY.
Property StretchFactorZ (p. 835) Gets or sets the StretchFactorZ.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)


Property SurfaceMeshMethod (p. 835) Gets or sets the SurfaceMeshMethod.
Property SweepBiasType (p. 835) Gets or sets the SweepBiasType.
Property SweepBiasValue (p. 835) Gets or sets the SweepBiasValue.
Property SweepEdges (p. 835) Gets or sets the SweepEdges.
Property SweepElementSize (p. 836) Gets or sets the SweepElementSize.
Property SweepESizeType (p. 836) Gets or sets the SweepESizeType.
Property SweepNumberDivisions (p. 836) Gets or sets the SweepNumberDivisions.
Property SweepSizeBehavior (p. 836) Gets or sets the SweepSizeBehavior.
Property TargetLocation (p. 836) Gets or sets the TargetLocation.
Property TetraGrowthRate (p. 836) Gets or sets the TetraGrowthRate.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 825
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Property WriteICEMCFDFiles (p. 837) Gets or sets the WriteICEMCFDFiles.

Active
Gets the Active.

Declaration Syntax
public bool Active { get; }

AggressiveInflateOption
Gets or sets the AggressiveInflateOption.

Declaration Syntax
public bool AggressiveInflateOption { set;get; }

AggressiveTetImprovement
Gets or sets the AggressiveTetImprovement.

Declaration Syntax
public bool AggressiveTetImprovement { set;get; }

Algorithm
Gets or sets the Algorithm.

Declaration Syntax
public MeshMethodAlgorithm Algorithm { set;get; }

ApproximativeNumberOfElementsPerPart
Gets or sets the ApproximativeNumberOfElementsPerPart.

Declaration Syntax
public uint ApproximativeNumberOfElementsPerPart { set;get; }

BFCartSubType
Gets the BFCartSubType.

Declaration Syntax
public int BFCartSubType { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
826 of ANSYS, Inc. and its subsidiaries and affiliates.
AutomaticMethod

BFCartTolerance
Gets the BFCartTolerance.

Declaration Syntax
public Quantity BFCartTolerance { get; }

ConstrainBoundary
Gets or sets the ConstrainBoundary.

Declaration Syntax
public bool ConstrainBoundary { set;get; }

ControlMessages
Gets the ControlMessages.

Declaration Syntax
public bool ControlMessages { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CornerAngle
Gets or sets the CornerAngle.

Declaration Syntax
public Quantity CornerAngle { set;get; }

CurvatureNormalAngle
Gets or sets the CurvatureNormalAngle.

Declaration Syntax
public Quantity CurvatureNormalAngle { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 827
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefeatureLayerVolume
Gets or sets the DefeatureLayerVolume.

Declaration Syntax
public double DefeatureLayerVolume { set;get; }

DefeaturingTolerance
Gets or sets the DefeaturingTolerance.

Declaration Syntax
public Quantity DefeaturingTolerance { set;get; }

DefinedBy
Gets or sets the DefinedBy.

Declaration Syntax
public PatchIndependentDefineType DefinedBy { set;get; }

ElementMidsideNodes ***OBSOLETE*** Use the ElementOrder property in-


stead.
Gets or sets the ElementMidsideNodes.

Declaration Syntax
public ElementMidsideNodesType ElementMidsideNodes { set;get; }

ElementOption
Gets or sets the ElementOption.

Declaration Syntax
public SweepElementOptionType ElementOption { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
828 of ANSYS, Inc. and its subsidiaries and affiliates.
AutomaticMethod

ElementOrder
Gets or sets the ElementOrder.

Declaration Syntax
public ElementOrder ElementOrder { set;get; }

FeatureAngle
Gets or sets the FeatureAngle.

Declaration Syntax
public Quantity FeatureAngle { set;get; }

FreeFaceMeshType
Gets or sets the FreeFaceMeshType.

Declaration Syntax
public int FreeFaceMeshType { set;get; }

FreeMeshType
Gets or sets the FreeMeshType.

Declaration Syntax
public int FreeMeshType { set;get; }

GenerateLayersUsingFacets
Gets or sets the GenerateLayersUsingFacets.

Declaration Syntax
public bool GenerateLayersUsingFacets { set;get; }

InflateRelativeTolerance
Gets or sets the InflateRelativeTolerance.

Declaration Syntax
public double InflateRelativeTolerance { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 829
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshControlAuto InternalObject { get; }

KeyPointsSelection
Gets or sets the KeyPointsSelection.

Declaration Syntax
public AutomaticOrManual KeyPointsSelection { set;get; }

LayerHeight
Gets or sets the LayerHeight.

Declaration Syntax
public double LayerHeight { set;get; }

LayerStart
Gets or sets the LayerStart.

Declaration Syntax
public double LayerStart { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MappedMeshType
Gets or sets the MappedMeshType.

Declaration Syntax
public int MappedMeshType { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
830 of ANSYS, Inc. and its subsidiaries and affiliates.
AutomaticMethod

MatchMeshWherePossible
Gets or sets the MatchMeshWherePossible.

Declaration Syntax
public bool MatchMeshWherePossible { set;get; }

MaximumElementSize
Gets or sets the MaximumElementSize.

Declaration Syntax
public Quantity MaximumElementSize { set;get; }

MeshBasedDefeaturing
Gets or sets the MeshBasedDefeaturing.

Declaration Syntax
public bool MeshBasedDefeaturing { set;get; }

MeshInCenter
Gets or sets the MeshInCenter.

Declaration Syntax
public int MeshInCenter { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public MethodType Method { set;get; }

MinimumEdgeLength
Gets the MinimumEdgeLength.

Declaration Syntax
public Quantity MinimumEdgeLength { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 831
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

MinimumSizeLimit
Gets or sets the MinimumSizeLimit.

Declaration Syntax
public Quantity MinimumSizeLimit { set;get; }

NumberOfCellsAcrossGap
Gets or sets the NumberOfCellsAcrossGap.

Declaration Syntax
public int NumberOfCellsAcrossGap { set;get; }

OverlappingAngle
Gets or sets the OverlappingAngle.

Declaration Syntax
public Quantity OverlappingAngle { set;get; }

PreserveBoundaries
Gets or sets the PreserveBoundaries.

Declaration Syntax
public int PreserveBoundaries { set;get; }

ProjectCornersToTop
Gets or sets the ProjectCornersToTop.

Declaration Syntax
public bool ProjectCornersToTop { set;get; }

ProjectInConstantZPlane
Gets or sets the ProjectInConstantZPlane.

Declaration Syntax
public bool ProjectInConstantZPlane { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
832 of ANSYS, Inc. and its subsidiaries and affiliates.
AutomaticMethod

ProjectionFactor
Gets or sets the ProjectionFactor.

Declaration Syntax
public double ProjectionFactor { set;get; }

Refinement
Gets or sets the Refinement.

Declaration Syntax
public int Refinement { set;get; }

RelativeTolerance
Gets or sets the PrimeRelativeTolerance.

Declaration Syntax
public double RelativeTolerance { set;get; }

RepairFacets
Gets or sets the RepairFacets.

Declaration Syntax
public bool RepairFacets { set;get; }

ReuseBlocking
Gets or sets the ReuseBlocking.

Declaration Syntax
public bool ReuseBlocking { set;get; }

SlicerFeatureAngle
Gets or sets the SlicerFeatureAngle.

Declaration Syntax
public double SlicerFeatureAngle { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 833
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

SliverTriangleHeight
Gets or sets the SliverTriangleHeight.

Declaration Syntax
public double SliverTriangleHeight { set;get; }

SmoothTransition
Gets or sets the SmoothTransition.

Declaration Syntax
public bool SmoothTransition { set;get; }

SourceLocation
Gets or sets the SourceLocation.

Declaration Syntax
public ISelectionInfo SourceLocation { set;get; }

SourceTargetSelection
Gets or sets the SourceTargetSelection.

Declaration Syntax
public int SourceTargetSelection { set;get; }

SpacingOption
Gets or sets the SpacingOption.

Declaration Syntax
public int SpacingOption { set;get; }

StretchFactorX
Gets or sets the StretchFactorX.

Declaration Syntax
public double StretchFactorX { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
834 of ANSYS, Inc. and its subsidiaries and affiliates.
AutomaticMethod

StretchFactorY
Gets or sets the StretchFactorY.

Declaration Syntax
public double StretchFactorY { set;get; }

StretchFactorZ
Gets or sets the StretchFactorZ.

Declaration Syntax
public double StretchFactorZ { set;get; }

SurfaceMeshMethod
Gets or sets the SurfaceMeshMethod.

Declaration Syntax
public int SurfaceMeshMethod { set;get; }

SweepBiasType
Gets or sets the SweepBiasType.

Declaration Syntax
public BiasType SweepBiasType { set;get; }

SweepBiasValue
Gets or sets the SweepBiasValue.

Declaration Syntax
public double SweepBiasValue { set;get; }

SweepEdges
Gets or sets the SweepEdges.

Declaration Syntax
public ISelectionInfo SweepEdges { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 835
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

SweepElementSize
Gets or sets the SweepElementSize.

Declaration Syntax
public Quantity SweepElementSize { set;get; }

SweepESizeType
Gets or sets the SweepESizeType.

Declaration Syntax
public int SweepESizeType { set;get; }

SweepNumberDivisions
Gets or sets the SweepNumberDivisions.

Declaration Syntax
public int SweepNumberDivisions { set;get; }

SweepSizeBehavior
Gets or sets the SweepSizeBehavior.

Declaration Syntax
public int SweepSizeBehavior { set;get; }

TargetLocation
Gets or sets the TargetLocation.

Declaration Syntax
public ISelectionInfo TargetLocation { set;get; }

TetraGrowthRate
Gets or sets the TetraGrowthRate.

Declaration Syntax
public double TetraGrowthRate { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
836 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactSizing

WriteICEMCFDFiles
Gets or sets the WriteICEMCFDFiles.

Declaration Syntax
public bool WriteICEMCFDFiles { set;get; }

ContactSizing
Defines a ContactSizing.

Declaration Syntax
public class ContactSizing : MeshControl

Table 252: Members

Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)


Property ContactRegion (p. 837) Gets or sets the ContactRegion.
Property DataModelObjectCategory (p. 838)Gets the current DataModelObject's
category.
Property ElementSize (p. 838) Gets or sets the ElementSize.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalObject (p. 838) Gets the internal object. For advanced usage
only.
Property Relevance (p. 838) Gets or sets the Relevance.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)


Property Type (p. 838) Gets or sets the Type.

ContactRegion
Gets or sets the ContactRegion.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 837
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementSize
Gets or sets the ElementSize.

Declaration Syntax
public Quantity ElementSize { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshControlAuto InternalObject { get; }

Relevance
Gets or sets the Relevance.

Declaration Syntax
public double Relevance { set;get; }

Type
Gets or sets the Type.

Declaration Syntax
public int Type { set;get; }

FaceMeshing
Defines a FaceMeshing.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
838 of ANSYS, Inc. and its subsidiaries and affiliates.
FaceMeshing

Declaration Syntax
public class FaceMeshing : MeshControl

Table 253: Members

Property Active (p. 839) Gets the Active.


Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)


Property ConstrainBoundary (p. 839) Gets or sets the ConstrainBoundary.
Property DataModelObjectCategory (p. 840) Gets the current DataModelObject's
category.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalNumberOfDivisions (p. 840) Gets or sets the InternalNumberOfDivisions.
Property InternalObject (p. 840) Gets the internal object. For advanced usage
only.
Property Location (p. 840) Gets or sets the Location.
Property MappedMesh (p. 840) Gets or sets the MappedMesh.
Property Method (p. 840) Gets or sets the Method.
Property SpecifiedCorners (p. 841) Gets or sets the SpecifiedCorners.
Property SpecifiedEnds (p. 841) Gets or sets the SpecifiedEnds.
Property SpecifiedSides (p. 841) Gets or sets the SpecifiedSides.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)

Active
Gets the Active.

Declaration Syntax
public bool Active { get; }

ConstrainBoundary
Gets or sets the ConstrainBoundary.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 839
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public int ConstrainBoundary { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalNumberOfDivisions
Gets or sets the InternalNumberOfDivisions.

Declaration Syntax
public int InternalNumberOfDivisions { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshControlAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MappedMesh
Gets or sets the MappedMesh.

Declaration Syntax
public bool MappedMesh { set;get; }

Method
Gets or sets the Method.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
840 of ANSYS, Inc. and its subsidiaries and affiliates.
Inflation

Declaration Syntax
public FaceMeshingMethod Method { set;get; }

SpecifiedCorners
Gets or sets the SpecifiedCorners.

Declaration Syntax
public ISelectionInfo SpecifiedCorners { set;get; }

SpecifiedEnds
Gets or sets the SpecifiedEnds.

Declaration Syntax
public ISelectionInfo SpecifiedEnds { set;get; }

SpecifiedSides
Gets or sets the SpecifiedSides.

Declaration Syntax
public ISelectionInfo SpecifiedSides { set;get; }

Inflation
Defines a Inflation.

Declaration Syntax
public class Inflation : MeshControl

Table 254: Members

Property Active (p. 842) Gets the Active.


Property AspectRatio (p. 842) Gets or sets the AspectRatio.
Property BoundaryLocation (p. 842) Gets or sets the BoundaryLocation.
Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 841
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Property DataModelObjectCategory (p. 843) Gets the current DataModelObject's


category.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property FirstLayerHeight (p. 843) Gets or sets the FirstLayerHeight.
Property GrowthRate (p. 843) Gets or sets the GrowthRate.
Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InflationAlgorithm (p. 843) Gets or sets the InflationAlgorithm.
Property InflationOption (p. 843) Gets or sets the InflationOption.
Property InternalObject (p. 843) Gets the internal object. For advanced usage
only.
Property Location (p. 844) Gets or sets the Location.
Property MaximumLayers (p. 844) Gets or sets the MaximumLayers.
Property MaximumThickness (p. 844) Gets or sets the MaximumThickness.
Property NumberOfLayers (p. 844) Gets or sets the NumberOfLayers.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)


Property TransitionRatio (p. 844) Gets or sets the TransitionRatio.

Active
Gets the Active.

Declaration Syntax
public bool Active { get; }

AspectRatio
Gets or sets the AspectRatio.

Declaration Syntax
public double AspectRatio { set;get; }

BoundaryLocation
Gets or sets the BoundaryLocation.

Declaration Syntax
public ISelectionInfo BoundaryLocation { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
842 of ANSYS, Inc. and its subsidiaries and affiliates.
Inflation

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FirstLayerHeight
Gets or sets the FirstLayerHeight.

Declaration Syntax
public Quantity FirstLayerHeight { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InflationAlgorithm
Gets or sets the InflationAlgorithm.

Declaration Syntax
public int InflationAlgorithm { set;get; }

InflationOption
Gets or sets the InflationOption.

Declaration Syntax
public int InflationOption { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshControlAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 843
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MaximumLayers
Gets or sets the MaximumLayers.

Declaration Syntax
public int MaximumLayers { set;get; }

MaximumThickness
Gets or sets the MaximumThickness.

Declaration Syntax
public Quantity MaximumThickness { set;get; }

NumberOfLayers
Gets or sets the NumberOfLayers.

Declaration Syntax
public int NumberOfLayers { set;get; }

TransitionRatio
Gets or sets the TransitionRatio.

Declaration Syntax
public double TransitionRatio { set;get; }

MatchControl
Defines a MatchControl.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
844 of ANSYS, Inc. and its subsidiaries and affiliates.
MatchControl

Declaration Syntax
public class MatchControl : MeshControl

Table 255: Members

Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)


Property ControlMessages (p. 845) Gets the ControlMessages.
Property DataModelObjectCategory (p. 845) Gets the current DataModelObject's
category.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property HighCoordinateSystem (p. 846) Gets or sets the HighCoordinateSystem.
Property HighGeometrySelection (p. 846) Gets or sets the HighGeometrySelection.
Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalObject (p. 846) Gets the internal object. For advanced usage
only.
Property LowCoordinateSystem (p. 846) Gets or sets the LowCoordinateSystem.
Property LowGeometrySelection (p. 846) Gets or sets the LowGeometrySelection.
Property RotationAxis (p. 846) Gets or sets the RotationAxis.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)


Property Transformation (p. 847) Gets or sets the Transformation.

ControlMessages
Gets the ControlMessages.

Declaration Syntax
public bool ControlMessages { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 845
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

HighCoordinateSystem
Gets or sets the HighCoordinateSystem.

Declaration Syntax
public CoordinateSystem HighCoordinateSystem { set;get; }

HighGeometrySelection
Gets or sets the HighGeometrySelection.

Declaration Syntax
public ISelectionInfo HighGeometrySelection { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshControlAuto InternalObject { get; }

LowCoordinateSystem
Gets or sets the LowCoordinateSystem.

Declaration Syntax
public CoordinateSystem LowCoordinateSystem { set;get; }

LowGeometrySelection
Gets or sets the LowGeometrySelection.

Declaration Syntax
public ISelectionInfo LowGeometrySelection { set;get; }

RotationAxis
Gets or sets the RotationAxis.

Declaration Syntax
public CoordinateSystem RotationAxis { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
846 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

Transformation
Gets or sets the Transformation.

Declaration Syntax
public int Transformation { set;get; }

Mesh
Defines a Mesh.

Declaration Syntax
public class Mesh : DataModelObject, IFolderDataModelObject

Table 256: Members

Property AspectRatio (p. 850) Gets or sets the AspectRatio.


Property AutomaticMeshBasedDefeaturing (p. 850) Gets or sets the
AutomaticMeshBasedDefeaturing.
Property Average (p. 850) Gets the Average.
Property CaptureCurvature (p. 851) Gets or sets the CaptureCurvature.
Property CaptureProximity (p. 851) Gets or sets the CaptureProximity.
Property Children (p. 851) Gets the list of children.
Property CollisionAvoidance (p. 851) Gets or sets the CollisionAvoidance.
Property Comments (p. 851) Gets the list of associated comments.
Property ConnectionSize (p. 851) Gets or sets the ConnectionSize.
Property ConnectionTolerance (p. 852) Gets or sets the ConnectionTolerance.
Property ConnectionToleranceList (p. 852) Gets or sets the ConnectionToleranceList.
Property ConnectionToleranceType (p. 852) Gets or sets the ConnectionToleranceType.
Property CoplanarAngleTol (p. 852) Gets or sets the CoplanarAngleTol.
Property CurvatureNormalAngle (p. 852) Gets or sets the CurvatureNormalAngle.
Property DataModelObjectCategory (p. 852) Gets the current DataModelObject's category.
Property DefeatureTolerance (p. 853) Gets or sets the DefeatureTolerance.
Property DisplayStyle (p. 853) Gets or sets the DisplayStyle.
Property ElementOrder (p. 853) Gets or sets the ElementOrder.
Property Elements (p. 853) Gets the Elements.
Property ElementSize (p. 853) Gets or sets the ElementSize.
Property ExportFormat (p. 853) Gets or sets the ExportFormat.
Property ExportUnit (p. 854) Gets or sets the ExportUnit.
Property ExtraRetriesForAssembly (p. 854) Gets or sets the ExtraRetriesForAssembly.
Property Figures (p. 854) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 847
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Property FilletRatio (p. 854) Gets or sets the FilletRatio.


Property FirstLayerHeight (p. 854) Gets or sets the FirstLayerHeight.
Property GeneratePinchOnRefresh (p. 854) Gets or sets the GeneratePinchOnRefresh.
Property GrowthRate (p. 855) Gets or sets the GrowthRate.
Property GrowthRateSF (p. 855) Gets or sets the GrowthRateSF.
Property GrowthRateType (p. 855) Gets or sets the GrowthRateType.
Property HoleRemovalTolerance (p. 855) Gets or sets the HoleRemovalTolerance.
Property Images (p. 855) Gets the list of associated images.
Property InflationAlgorithm (p. 855) Gets or sets the InflationAlgorithm.
Property InflationOption (p. 856) Gets or sets the InflationOption.
Property InitialSizeSeed (p. 856) Gets or sets the InitialSizeSeed.
Property InternalObject (p. 856) Gets the internal object. For advanced usage
only.
Property LocalConnectionOption (p. 856) Gets or sets the LocalConnectionOption.
Property LocalConnectionTolerance (p. 856) Gets or sets the LocalConnectionTolerance.
Property Maximum (p. 856) Gets the Maximum.
Property MaximumAngle (p. 857) Gets or sets the MaximumAngle.
Property MaximumHeightOverBase (p. 857) Gets or sets the MaximumHeightOverBase.
Property MaximumLayers (p. 857) Gets or sets the MaximumLayers.
Property MaximumSize (p. 857) Gets or sets the MaximumSize.
Property MaximumThickness (p. 857) Gets or sets the MaximumThickness.
Property MeshBasedConnection (p. 857) Gets or sets the MeshBasedConnection.
Property MeshMetric (p. 858) Gets or sets the MeshMetric.
Property MeshMorphing (p. 858) Gets or sets the MeshMorphing.
Property Method (p. 858) Gets or sets the Method.
Property Minimum (p. 858) Gets the Minimum.
Property MinimumEdgeLength (p. 858) Gets the MinimumEdgeLength.
Property MinimumSize (p. 858) Gets or sets the MinimumSize.
Property MultiConnectionSteps (p. 859) Gets or sets the MultiConnectionSteps.
Property NamedSelection (p. 859) Gets or sets the NamedSelection.
Property Nodes (p. 859) Gets the Nodes.
Property NumberOfCellsAcrossGap (p. 859) Gets or sets the NumberOfCellsAcrossGap.
Property NumberOfCPUsForParallelPartMeshing (p. 859) Gets or sets the
NumberOfCPUsForParallelPartMeshing.
Property NumberOfRetries (p. 859) Gets or sets the NumberOfRetries.
Property PhysicsPreference (p. 860) Gets or sets the PhysicsPreference.
Property PinchTolerance (p. 860) Gets or sets the PinchTolerance.
Property ProximityMinimumSize (p. 860) Gets or sets the ProximityMinimumSize.
Property ProximitySizeFunctionSources (p. 860) Gets or sets the
ProximitySizeFunctionSources.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
848 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

Property QuadMesh (p. 860) Gets or sets the QuadMesh.


Property ReadOnly (p. 860) Gets the ReadOnly.
Property Relevance (p. 861) Gets or sets the Relevance.
Property RelevanceCenter (p. 861) Gets or sets the RelevanceCenter.
Property Resolution (p. 861) Gets or sets the Resolution.
Property RigidBodyBehavior (p. 861) Gets the RigidBodyBehavior.
Property ShapeChecking (p. 861) Gets or sets the ShapeChecking.
Property SheetLoopRemoval (p. 861) Gets or sets the SheetLoopRemoval.
Property Smoothing (p. 862) Gets or sets the Smoothing.
Property SmoothingIterations (p. 862) Gets or sets the SmoothingIterations.
Property SolverPreference (p. 862) Gets or sets the SolverPreference.
Property SpanAngleCenter (p. 862) Gets or sets the SpanAngleCenter.
Property StandardDeviation (p. 862) Gets the StandardDeviation.
Property StraightSidedElements (p. 862) Gets or sets the StraightSidedElements.
Property TargetQuality (p. 863) Gets or sets the TargetQuality.
Property TargetSkewness (p. 863) Gets or sets the TargetSkewness.
Property TopologyChecking (p. 863) Gets or sets the TopologyChecking.
Property TransitionOption (p. 863) Gets or sets the TransitionOption.
Property TransitionRatio (p. 863) Gets or sets the TransitionRatio.
Property TriangleSurfaceMesher (p. 863) Gets or sets the TriangleSurfaceMesher.
Property UseAdaptiveSizing (p. 864) Gets or sets the UseAdaptiveSizing.
Property UseAdvancedSizeFunction (p. 864) Gets or sets the UseAdvancedSizeFunction.
Property UseAutomaticInflation (p. 864) Gets or sets the UseAutomaticInflation.
Property UseFixedSizeFunctionForSheets (p. 864) Gets or sets the
UseFixedSizeFunctionForSheets.
Property UsePostSmoothing (p. 864) Gets or sets the UsePostSmoothing.
Property UseSheetThicknessForPinch (p. 864) Gets or sets the UseSheetThicknessForPinch.
Property ViewAdvancedOptions (p. 865) Gets or sets the ViewAdvancedOptions.
Property Worksheet (p. 865) Get the MeshControlWorksheet action.
Method AddAutomaticMethod() (p. 865) Creates a new AutomaticMethod
Method AddComment() (p. 865) Creates a new child Comment.
Method AddContactMatchGroup() (p. 865) Add a new AddContactMatchGroup.
Method AddContactSizing() (p. 865) Creates a new ContactSizing
Method AddFaceMeshing() (p. 866) Creates a new FaceMeshing
Method AddFigure() (p. 866) Creates a new child Figure.
Method AddImage(string) (p. 866) Creates a new child Image. If a 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 AddInflation() (p. 866) Creates a new Inflation

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 849
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Method AddManualMeshConnection() (p. 866) Add a new ManualMeshConnection


Method AddMatchControl() (p. 866) Creates a new MatchControl
Method AddMeshConnectionGroup() (p. 867) Add a new MeshConnectionGroup.
Method AddNodeMerge() (p. 867) Add a new NodeMerge.
Method AddNodeMergeGroup() (p. 867) Add a new NodeMergeGroup.
Method AddPinch() (p. 867) Creates a new Pinch
Method AddRefinement() (p. 867) Creates a new Refinement
Method AddSizing() (p. 867) Creates a new Sizing
Method ClearGeneratedData() (p. 868) Run the ClearGeneratedData action.
Method CreatePinchControls() (p. 868) Run the CreatePinchControls action.
Method GenerateMesh() (p. 868) Run the GenerateMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 868)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 868)
Method PreviewInflation() (p. 869) Run the PreviewInflation action.
Method PreviewSurfaceMesh() (p. 869) Run the PreviewSurfaceMesh action.
Method ShowMappableBodies() (p. 869) Run the ShowMappableBodies action.
Method ShowSweepableBodies() (p. 869) Run the ShowSweepableBodies action.
Method Update() (p. 870) Run the Update action.

AspectRatio
Gets or sets the AspectRatio.

Declaration Syntax
public double AspectRatio { set;get; }

AutomaticMeshBasedDefeaturing
Gets or sets the AutomaticMeshBasedDefeaturing.

Declaration Syntax
public int AutomaticMeshBasedDefeaturing { set;get; }

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
850 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

CaptureCurvature
Gets or sets the CaptureCurvature.

Declaration Syntax
public bool CaptureCurvature { set;get; }

CaptureProximity
Gets or sets the CaptureProximity.

Declaration Syntax
public bool CaptureProximity { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

CollisionAvoidance
Gets or sets the CollisionAvoidance.

Declaration Syntax
public int CollisionAvoidance { set;get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ConnectionSize
Gets or sets the ConnectionSize.

Declaration Syntax
public double ConnectionSize { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 851
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

ConnectionTolerance
Gets or sets the ConnectionTolerance.

Declaration Syntax
public double ConnectionTolerance { set;get; }

ConnectionToleranceList
Gets or sets the ConnectionToleranceList.

Declaration Syntax
public string ConnectionToleranceList { set;get; }

ConnectionToleranceType
Gets or sets the ConnectionToleranceType.

Declaration Syntax
public int ConnectionToleranceType { set;get; }

CoplanarAngleTol
Gets or sets the CoplanarAngleTol.

Declaration Syntax
public Quantity CoplanarAngleTol { set;get; }

CurvatureNormalAngle
Gets or sets the CurvatureNormalAngle.

Declaration Syntax
public Quantity CurvatureNormalAngle { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
852 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

DefeatureTolerance
Gets or sets the DefeatureTolerance.

Declaration Syntax
public Quantity DefeatureTolerance { set;get; }

DisplayStyle
Gets or sets the DisplayStyle.

Declaration Syntax
public MeshDisplayStyle DisplayStyle { set;get; }

ElementOrder
Gets or sets the ElementOrder.

Declaration Syntax
public ElementOrder ElementOrder { set;get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

ElementSize
Gets or sets the ElementSize.

Declaration Syntax
public Quantity ElementSize { set;get; }

ExportFormat
Gets or sets the ExportFormat.

Declaration Syntax
public FluentExportMeshType ExportFormat { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 853
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

ExportUnit
Gets or sets the ExportUnit.

Declaration Syntax
public PolyflowExportUnit ExportUnit { set;get; }

ExtraRetriesForAssembly
Gets or sets the ExtraRetriesForAssembly.

Declaration Syntax
public bool ExtraRetriesForAssembly { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FilletRatio
Gets or sets the FilletRatio.

Declaration Syntax
public double FilletRatio { set;get; }

FirstLayerHeight
Gets or sets the FirstLayerHeight.

Declaration Syntax
public Quantity FirstLayerHeight { set;get; }

GeneratePinchOnRefresh
Gets or sets the GeneratePinchOnRefresh.

Declaration Syntax
public int GeneratePinchOnRefresh { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
854 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

GrowthRateSF
Gets or sets the GrowthRateSF.

Declaration Syntax
public double GrowthRateSF { set;get; }

GrowthRateType
Gets or sets the GrowthRateType.

Declaration Syntax
public int GrowthRateType { set;get; }

HoleRemovalTolerance
Gets or sets the HoleRemovalTolerance.

Declaration Syntax
public double HoleRemovalTolerance { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InflationAlgorithm
Gets or sets the InflationAlgorithm.

Declaration Syntax
public int InflationAlgorithm { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 855
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

InflationOption
Gets or sets the InflationOption.

Declaration Syntax
public int InflationOption { set;get; }

InitialSizeSeed
Gets or sets the InitialSizeSeed.

Declaration Syntax
public int InitialSizeSeed { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshControlGroupAuto InternalObject { get; }

LocalConnectionOption
Gets or sets the LocalConnectionOption.

Declaration Syntax
public int LocalConnectionOption { set;get; }

LocalConnectionTolerance
Gets or sets the LocalConnectionTolerance.

Declaration Syntax
public string LocalConnectionTolerance { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
856 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

MaximumAngle
Gets or sets the MaximumAngle.

Declaration Syntax
public Quantity MaximumAngle { set;get; }

MaximumHeightOverBase
Gets or sets the MaximumHeightOverBase.

Declaration Syntax
public double MaximumHeightOverBase { set;get; }

MaximumLayers
Gets or sets the MaximumLayers.

Declaration Syntax
public int MaximumLayers { set;get; }

MaximumSize
Gets or sets the MaximumSize.

Declaration Syntax
public Quantity MaximumSize { set;get; }

MaximumThickness
Gets or sets the MaximumThickness.

Declaration Syntax
public Quantity MaximumThickness { set;get; }

MeshBasedConnection
Gets or sets the MeshBasedConnection.

Declaration Syntax
public bool MeshBasedConnection { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 857
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

MeshMetric
Gets or sets the MeshMetric.

Declaration Syntax
public int MeshMetric { set;get; }

MeshMorphing
Gets or sets the MeshMorphing.

Declaration Syntax
public bool MeshMorphing { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public int Method { set;get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumEdgeLength
Gets the MinimumEdgeLength.

Declaration Syntax
public Quantity MinimumEdgeLength { get; }

MinimumSize
Gets or sets the MinimumSize.

Declaration Syntax
public Quantity MinimumSize { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
858 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

MultiConnectionSteps
Gets or sets the MultiConnectionSteps.

Declaration Syntax
public bool MultiConnectionSteps { set;get; }

NamedSelection
Gets or sets the NamedSelection.

Declaration Syntax
public NamedSelection NamedSelection { set;get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

NumberOfCellsAcrossGap
Gets or sets the NumberOfCellsAcrossGap.

Declaration Syntax
public int NumberOfCellsAcrossGap { set;get; }

NumberOfCPUsForParallelPartMeshing
Gets or sets the NumberOfCPUsForParallelPartMeshing.

Declaration Syntax
public int NumberOfCPUsForParallelPartMeshing { set;get; }

NumberOfRetries
Gets or sets the NumberOfRetries.

Declaration Syntax
public int NumberOfRetries { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 859
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

PhysicsPreference
Gets or sets the PhysicsPreference.

Declaration Syntax
public MeshPhysicsPreferenceType PhysicsPreference { set;get; }

PinchTolerance
Gets or sets the PinchTolerance.

Declaration Syntax
public Quantity PinchTolerance { set;get; }

ProximityMinimumSize
Gets or sets the ProximityMinimumSize.

Declaration Syntax
public Quantity ProximityMinimumSize { set;get; }

ProximitySizeFunctionSources
Gets or sets the ProximitySizeFunctionSources.

Declaration Syntax
public ProximitySFSourcesType ProximitySizeFunctionSources { set;get; }

QuadMesh
Gets or sets the QuadMesh.

Declaration Syntax
public bool QuadMesh { set;get; }

ReadOnly
Gets the ReadOnly.

Declaration Syntax
public bool ReadOnly { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
860 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

Relevance
Gets or sets the Relevance.

Declaration Syntax
public int Relevance { set;get; }

RelevanceCenter
Gets or sets the RelevanceCenter.

Declaration Syntax
public int RelevanceCenter { set;get; }

Resolution
Gets or sets the Resolution.

Declaration Syntax
public int Resolution { set;get; }

RigidBodyBehavior
Gets the RigidBodyBehavior.

Declaration Syntax
public int RigidBodyBehavior { get; }

ShapeChecking
Gets or sets the ShapeChecking.

Declaration Syntax
public int ShapeChecking { set;get; }

SheetLoopRemoval
Gets or sets the SheetLoopRemoval.

Declaration Syntax
public bool SheetLoopRemoval { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 861
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Smoothing
Gets or sets the Smoothing.

Declaration Syntax
public int Smoothing { set;get; }

SmoothingIterations
Gets or sets the SmoothingIterations.

Declaration Syntax
public int SmoothingIterations { set;get; }

SolverPreference
Gets or sets the SolverPreference.

Declaration Syntax
public MeshSolverPreferenceType SolverPreference { set;get; }

SpanAngleCenter
Gets or sets the SpanAngleCenter.

Declaration Syntax
public int SpanAngleCenter { set;get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public Quantity StandardDeviation { get; }

StraightSidedElements
Gets or sets the StraightSidedElements.

Declaration Syntax
public bool StraightSidedElements { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
862 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

TargetQuality
Gets or sets the TargetQuality.

Declaration Syntax
public Quantity TargetQuality { set;get; }

TargetSkewness
Gets or sets the TargetSkewness.

Declaration Syntax
public Quantity TargetSkewness { set;get; }

TopologyChecking
Gets or sets the TopologyChecking.

Declaration Syntax
public bool TopologyChecking { set;get; }

TransitionOption
Gets or sets the TransitionOption.

Declaration Syntax
public int TransitionOption { set;get; }

TransitionRatio
Gets or sets the TransitionRatio.

Declaration Syntax
public double TransitionRatio { set;get; }

TriangleSurfaceMesher
Gets or sets the TriangleSurfaceMesher.

Declaration Syntax
public int TriangleSurfaceMesher { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 863
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

UseAdaptiveSizing
Gets or sets the UseAdaptiveSizing.

Declaration Syntax
public bool UseAdaptiveSizing { set;get; }

UseAdvancedSizeFunction
Gets or sets the UseAdvancedSizeFunction.

Declaration Syntax
public int UseAdvancedSizeFunction { set;get; }

UseAutomaticInflation
Gets or sets the UseAutomaticInflation.

Declaration Syntax
public int UseAutomaticInflation { set;get; }

UseFixedSizeFunctionForSheets
Gets or sets the UseFixedSizeFunctionForSheets.

Declaration Syntax
public bool UseFixedSizeFunctionForSheets { set;get; }

UsePostSmoothing
Gets or sets the UsePostSmoothing.

Declaration Syntax
public int UsePostSmoothing { set;get; }

UseSheetThicknessForPinch
Gets or sets the UseSheetThicknessForPinch.

Declaration Syntax
public bool UseSheetThicknessForPinch { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
864 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

ViewAdvancedOptions
Gets or sets the ViewAdvancedOptions.

Declaration Syntax
public bool ViewAdvancedOptions { set;get; }

Worksheet
Get the MeshControlWorksheet action.

Declaration Syntax
public IWorksheet Worksheet { get; }

AddAutomaticMethod()
Creates a new AutomaticMethod

Declaration Syntax
public virtual AutomaticMethod AddAutomaticMethod()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddContactMatchGroup()
Add a new AddContactMatchGroup.

Declaration Syntax
public virtual ContactMatchGroup AddContactMatchGroup()

AddContactSizing()
Creates a new ContactSizing

Declaration Syntax
public virtual ContactSizing AddContactSizing()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 865
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

AddFaceMeshing()
Creates a new FaceMeshing

Declaration Syntax
public virtual FaceMeshing AddFaceMeshing()

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.

AddInflation()
Creates a new Inflation

Declaration Syntax
public virtual Inflation AddInflation()

AddManualMeshConnection()
Add a new ManualMeshConnection

Declaration Syntax
public virtual void AddManualMeshConnection()

AddMatchControl()
Creates a new MatchControl

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
866 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

Declaration Syntax
public virtual MatchControl AddMatchControl()

AddMeshConnectionGroup()
Add a new MeshConnectionGroup.

Declaration Syntax
public virtual MeshConnectionGroup AddMeshConnectionGroup()

AddNodeMerge()
Add a new NodeMerge.

Declaration Syntax
public virtual void AddNodeMerge()

AddNodeMergeGroup()
Add a new NodeMergeGroup.

Declaration Syntax
public virtual NodeMergeGroup AddNodeMergeGroup()

AddPinch()
Creates a new Pinch

Declaration Syntax
public virtual Pinch AddPinch()

AddRefinement()
Creates a new Refinement

Declaration Syntax
public virtual Refinement AddRefinement()

AddSizing()
Creates a new Sizing

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 867
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public virtual Sizing AddSizing()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreatePinchControls()
Run the CreatePinchControls action.

Declaration Syntax
public virtual void CreatePinchControls()

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<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
868 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

PreviewInflation()
Run the PreviewInflation action.

Declaration Syntax
public virtual void PreviewInflation()

PreviewSurfaceMesh()
Run the PreviewSurfaceMesh action.

Declaration Syntax
public virtual void PreviewSurfaceMesh()

ShowMappableBodies()
Run the ShowMappableBodies action.

Declaration Syntax
public virtual void ShowMappableBodies()

ShowSweepableBodies()
Run the ShowSweepableBodies action.

Declaration Syntax
public virtual void ShowSweepableBodies()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 869
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Update()
Run the Update action.

Declaration Syntax
public virtual void Update()

MeshControl
Defines a MeshControl.

Declaration Syntax
public class MeshControl : DataModelObject, IFolderDataModelObject

Table 257: Members

Property Children (p. 870) Gets the list of children.


Property Comments (p. 871) Gets the list of associated comments.
Property DataModelObjectCategory (p. 871) Gets the current DataModelObject's category.
Property Figures (p. 871) Gets the list of associated figures.
Property Images (p. 871) Gets the list of associated images.
Property InternalObject (p. 871) Gets the internal object. For advanced usage only.
Property Suppressed (p. 871) Gets or sets the Suppressed.
Method AddComment() (p. 872) Creates a new child Comment.
Method AddFigure() (p. 872) Creates a new child Figure.
Method AddImage(string) (p. 872) Creates a new child Image. If a 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. 872) Run the Delete action.
Method GenerateMesh() (p. 872) Generate the Mesh.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 872)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 873)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
870 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshControl

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 IDSMeshControlAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 871
Ansys.ACT.Automation.Mechanical.MeshControls 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()

GenerateMesh()
Generate the Mesh.

Declaration Syntax
public virtual void GenerateMesh()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
872 of ANSYS, Inc. and its subsidiaries and affiliates.
Pinch

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Pinch
Defines a Pinch.

Declaration Syntax
public class Pinch : MeshControl

Table 258: Members

Property AutoManualMode (p. 874) Gets the AutoManualMode.


Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 873
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Property DataModelObjectCategory (p. 874)Gets the current DataModelObject's


category.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalObject (p. 874) Gets the internal object. For advanced usage
only.
Property MasterGeometry (p. 874) Gets or sets the MasterGeometry.
Property SlaveGeometry (p. 875) Gets or sets the SlaveGeometry.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)


Property Tolerance (p. 875) Gets or sets the Tolerance.

AutoManualMode
Gets the AutoManualMode.

Declaration Syntax
public int AutoManualMode { 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 IDSMeshControlAuto InternalObject { get; }

MasterGeometry
Gets or sets the MasterGeometry.

Declaration Syntax
public ISelectionInfo MasterGeometry { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
874 of ANSYS, Inc. and its subsidiaries and affiliates.
Refinement

SlaveGeometry
Gets or sets the SlaveGeometry.

Declaration Syntax
public ISelectionInfo SlaveGeometry { set;get; }

Tolerance
Gets or sets the Tolerance.

Declaration Syntax
public Quantity Tolerance { set;get; }

Refinement
Defines a Refinement.

Declaration Syntax
public class Refinement : MeshControl

Table 259: Members

Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)


Property DataModelObjectCategory (p. 876)Gets the current DataModelObject's
category.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalObject (p. 876) Gets the internal object. For advanced usage
only.
Property Location (p. 876) Gets or sets the Location.
Property NumberOfRefinements (p. 876) Gets or sets the NumberOfRefinements.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 875
Ansys.ACT.Automation.Mechanical.MeshControls 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 IDSMeshControlAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NumberOfRefinements
Gets or sets the NumberOfRefinements.

Declaration Syntax
public int NumberOfRefinements { set;get; }

Relevance
Defines a Relevance.

Declaration Syntax
public class Relevance : MeshControl

Table 260: Members

Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
876 of ANSYS, Inc. and its subsidiaries and affiliates.
Relevance

Property DataModelObjectCategory (p. 877)Gets the current DataModelObject's


category.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalObject (p. 877) Gets the internal object. For advanced usage
only.
Property Location (p. 877) Gets or sets the Location.
Property PartRelavance (p. 877) Gets the PartRelavance.
Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)

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 IDSMeshControlAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

PartRelavance
Gets the PartRelavance.

Declaration Syntax
public int PartRelavance { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 877
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Sizing
Defines a Sizing.

Declaration Syntax
public class Sizing : MeshControl

Table 261: Members

Property Active (p. 879) Gets the Active.


Property Behavior (p. 879) Gets or sets the Behavior.
Property BiasFactor (p. 879) Gets or sets the BiasFactor.
Property BiasGrowthRate (p. 879) Gets or sets the BiasGrowthRate.
Property BiasOption (p. 879) Gets or sets the BiasOption.
Property BiasType (p. 879) Gets or sets the BiasType.
Property BodyOfInfluence (p. 880) Gets the BodyOfInfluence.
Property Children (p. 870) Gets the list of children.

(Inherited from MeshControl (p. 870).)


Property Comments (p. 871) Gets the list of associated comments.

(Inherited from MeshControl (p. 870).)


Property CurvatureNormalAngle (p. 880) Gets or sets the CurvatureNormalAngle.
Property DataModelObjectCategory (p. 880) Gets the current DataModelObject's
category.
Property ElementSize (p. 880) Gets or sets the ElementSize.
Property Figures (p. 871) Gets the list of associated figures.

(Inherited from MeshControl (p. 870).)


Property GrowthRate (p. 880) Gets or sets the GrowthRate.
Property Images (p. 871) Gets the list of associated images.

(Inherited from MeshControl (p. 870).)


Property InternalObject (p. 880) Gets the internal object. For advanced usage
only.
Property LocalMinimumSize (p. 881) Gets or sets the LocalMinimumSize.
Property Location (p. 881) Gets or sets the Location.
Property NumberOfDivisions (p. 881) Gets or sets the NumberOfDivisions.
Property OriginX (p. 881) Gets the OriginX.
Property OriginY (p. 881) Gets the OriginY.
Property OriginZ (p. 881) Gets the OriginZ.
Property ReverseBias (p. 882) Gets or sets the ReverseBias.
Property SphereCenter (p. 882) Gets or sets the SphereCenter.
Property SphereRadius (p. 882) Gets or sets the SphereRadius.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
878 of ANSYS, Inc. and its subsidiaries and affiliates.
Sizing

Property Suppressed (p. 871) Gets or sets the Suppressed.

(Inherited from MeshControl (p. 870).)


Property Type (p. 882) Gets or sets the Type.

Active
Gets the Active.

Declaration Syntax
public bool Active { get; }

Behavior
Gets or sets the Behavior.

Declaration Syntax
public SizingBehavior Behavior { set;get; }

BiasFactor
Gets or sets the BiasFactor.

Declaration Syntax
public double BiasFactor { set;get; }

BiasGrowthRate
Gets or sets the BiasGrowthRate.

Declaration Syntax
public double BiasGrowthRate { set;get; }

BiasOption
Gets or sets the BiasOption.

Declaration Syntax
public BiasOptionType BiasOption { set;get; }

BiasType
Gets or sets the BiasType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 879
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public BiasType BiasType { set;get; }

BodyOfInfluence
Gets the BodyOfInfluence.

Declaration Syntax
public ISelectionInfo BodyOfInfluence { set;get; }

CurvatureNormalAngle
Gets or sets the CurvatureNormalAngle.

Declaration Syntax
public Quantity CurvatureNormalAngle { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementSize
Gets or sets the ElementSize.

Declaration Syntax
public Quantity ElementSize { 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
880 of ANSYS, Inc. and its subsidiaries and affiliates.
Sizing

Declaration Syntax
public IDSMeshControlAuto InternalObject { get; }

LocalMinimumSize
Gets or sets the LocalMinimumSize.

Declaration Syntax
public Quantity LocalMinimumSize { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NumberOfDivisions
Gets or sets the NumberOfDivisions.

Declaration Syntax
public int NumberOfDivisions { set;get; }

OriginX
Gets the OriginX.

Declaration Syntax
public Quantity OriginX { get; }

OriginY
Gets the OriginY.

Declaration Syntax
public Quantity OriginY { get; }

OriginZ
Gets the OriginZ.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 881
Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public Quantity OriginZ { get; }

ReverseBias
Gets or sets the ReverseBias.

Declaration Syntax
public ISelectionInfo ReverseBias { set;get; }

SphereCenter
Gets or sets the SphereCenter.

Declaration Syntax
public CoordinateSystem SphereCenter { set;get; }

SphereRadius
Gets or sets the SphereRadius.

Declaration Syntax
public Quantity SphereRadius { set;get; }

Type
Gets or sets the Type.

Declaration Syntax
public SizingType Type { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
882 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results

Table 262: Members

Alert (p. 883) Defines a Alert.


ContactDataTable (p. 887) Defines a ContactDataTable.
Convergence (p. 889) Defines a Convergence.
LatticeDensity (p. 893) Defines a LatticeDensity.
LatticeElementalDensity (p. 895) Defines a LatticeElementalDensity.
MagneticCoenergy (p. 897) Defines a MagneticCoenergy.
MagneticPotential (p. 901) Defines a MagneticPotential.
NewtonRaphsonResidualForce (p. 905) Defines a
NewtonRaphsonResidualForce.
NewtonRaphsonResidualHeat (p. 908) Defines a
NewtonRaphsonResidualHeat.
NewtonRaphsonResidualMoment (p. 912) Defines a
NewtonRaphsonResidualMoment.
Result (p. 916) Defines a Result.
ResultChart (p. 929) Defines a ResultChart.
ResultTable (p. 939) Defines a ResultTable.
ShapeFinder (p. 942) Defines a ShapeFinder.
ShapeFinderElemental (p. 946) Defines a ShapeFinderElemental.
Smoothing (p. 950) Defines a Smoothing.
TopologyDensity (p. 951) Defines a TopologyDensity.
TopologyElementalDensity (p. 954) Defines a TopologyElementalDensity.
TopologyOptimizationResult (p. 956) Defines a
TopologyOptimizationResult.
UserDefinedResult (p. 962) Defines a UserDefinedResult.
VariableGraph (p. 975) Defines a VariableGraph.
Volume (p. 979) Defines a Volume.

Alert
Defines a Alert.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 883
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class Alert : DataModelObject, IFolderDataModelObject

Table 263: Members

Property Children (p. 884) Gets the list of children.


Property Comments (p. 884) Gets the list of associated comments.
Property DataModelObjectCategory (p. 884) Gets the current DataModelObject's category.
Property FailsIf (p. 885) Gets or sets the FailsIf.
Property Images (p. 885) Gets the list of associated images.
Property InternalObject (p. 885) Gets the internal object. For advanced usage only.
Property Status (p. 885) Gets the Status.
Property Value (p. 885) Gets or sets the Value.
Method AddComment() (p. 885) Creates a new child Comment.
Method AddImage(string) (p. 886) Creates a new child Image. If a 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. 886) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 886)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 886)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
884 of ANSYS, Inc. and its subsidiaries and affiliates.
Alert

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.

Declaration Syntax
public double Value { set;get; }

AddComment()
Creates a new child Comment.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 885
Ansys.ACT.Automation.Mechanical.Results 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.)

GetChildren(DataModelObjectCategory, bool, IList<DataModelObject>)


Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
886 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDataTable

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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 264: Members

Property Children (p. 887) Gets the list of children.


Property Comments (p. 888) Gets the list of associated comments.
Property DataModelObjectCategory (p. 888) Gets the current DataModelObject's
category.
Property Figures (p. 888) Gets the list of associated figures.
Property InternalObject (p. 888) Gets the internal object. For advanced usage
only.
Method AddComment() (p. 888) Creates a new child Comment.
Method AddFigure() (p. 888) Creates a new child Figure.
Method Delete() (p. 889) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 889)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 889)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 887
Ansys.ACT.Automation.Mechanical.Results 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; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSContactDataTableAuto 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
888 of ANSYS, Inc. and its subsidiaries and affiliates.
Convergence

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

Convergence
Defines a Convergence.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 889
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class Convergence : DataModelObject, IFolderDataModelObject

Table 265: Members

Property AllowableChange (p. 890) Gets or sets the AllowableChange.


Property Children (p. 890) Gets the list of children.
Property Comments (p. 891) Gets the list of associated comments.
Property DataModelObjectCategory (p. 891) Gets the current DataModelObject's category.
Property Figures (p. 891) Gets the list of associated figures.
Property Images (p. 891) Gets the list of associated images.
Property InternalObject (p. 891) Gets the internal object. For advanced usage only.
Property IsConverged (p. 891) Gets the IsConverged.
Property LastChange (p. 892) Gets the LastChange.
Property Type (p. 892) Gets or sets the Type.
Method AddComment() (p. 892) Creates a new child Comment.
Method AddFigure() (p. 892) Creates a new child Figure.
Method AddImage(string) (p. 892) Creates a new child Image. If a 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. 892) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 893)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 893)

AllowableChange
Gets or sets the AllowableChange.

Declaration Syntax
public double AllowableChange { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
890 of ANSYS, Inc. and its subsidiaries and affiliates.
Convergence

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 IDSConvergenceAuto InternalObject { get; }

IsConverged
Gets the IsConverged.

Declaration Syntax
public bool IsConverged { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 891
Ansys.ACT.Automation.Mechanical.Results Namespace

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()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
892 of ANSYS, Inc. and its subsidiaries and affiliates.
LatticeDensity

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

LatticeDensity
Defines a LatticeDensity.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 893
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class LatticeDensity : TopologyOptimizationResult

Table 266: Members

Property Children (p. 957) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Comments (p. 957) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property DataModelObjectCategory (p. 895)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 957) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Figures (p. 958) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalMass (p. 958) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalVolume (p. 958) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Images (p. 958) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property InternalObject (p. 895) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 958) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Location (p. 959) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Maximum (p. 959) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Minimum (p. 959) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
894 of ANSYS, Inc. and its subsidiaries and affiliates.
LatticeElementalDensity

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalMass (p. 959) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalVolume (p. 959) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentMassOfOriginal (p. 959) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentVolumeOfOriginal (p. 960) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property ShowOptimizedRegion (p. 960) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Suppressed (p. 960) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 956).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 895
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class LatticeElementalDensity : TopologyOptimizationResult

Table 267: Members

Property Children (p. 957) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Comments (p. 957) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property DataModelObjectCategory (p. 897)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 957) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Figures (p. 958) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalMass (p. 958) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalVolume (p. 958) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Images (p. 958) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property InternalObject (p. 897) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 958) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Location (p. 959) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Maximum (p. 959) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Minimum (p. 959) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
896 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticCoenergy

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalMass (p. 959) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalVolume (p. 959) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentMassOfOriginal (p. 959) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentVolumeOfOriginal (p. 960) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property ShowOptimizedRegion (p. 960) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Suppressed (p. 960) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 956).)

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; }

MagneticCoenergy
Defines a MagneticCoenergy.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 897
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class MagneticCoenergy : Result

Table 268: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 901) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
898 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticCoenergy

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 901) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 899
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
900 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticPotential

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

MagneticPotential
Defines a MagneticPotential.

Declaration Syntax
public class MagneticPotential : Result

Table 269: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 901
Ansys.ACT.Automation.Mechanical.Results Namespace

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 904) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 905) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
902 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticPotential

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 903
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
904 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualForce

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 270: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 908) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 905
Ansys.ACT.Automation.Mechanical.Results Namespace

Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 908) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
906 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualForce

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 907
Ansys.ACT.Automation.Mechanical.Results Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
908 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualHeat

Declaration Syntax
public class NewtonRaphsonResidualHeat : Result

Table 271: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 912) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 909
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 912) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
910 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualHeat

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 911
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NewtonRaphsonResidualMoment
Defines a NewtonRaphsonResidualMoment.

Declaration Syntax
public class NewtonRaphsonResidualMoment : Result

Table 272: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
912 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualMoment

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 915) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 916) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 913
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
914 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualMoment

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 915
Ansys.ACT.Automation.Mechanical.Results Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Result
Defines a Result.

Declaration Syntax
public abstract class Result : DataModelObject, IFolderDataModelObject

Table 273: Members

Property Average (p. 918) Gets the Average.


Property By (p. 918) Gets or sets the By.
Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.
Property Children (p. 918) Gets the list of children.
Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.
Property Comments (p. 919) Gets the list of associated comments.
Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.
Property DataModelObjectCategory (p. 919) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.
Property DisplayTime (p. 919) Gets or sets the DisplayTime.
Property Figures (p. 920) Gets the list of associated figures.
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.
Property Identifier (p. 920) Gets or sets the Identifier.
Property Images (p. 920) Gets the list of associated images.
Property InternalObject (p. 920) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.
Property ItemType (p. 921) Gets or sets the ItemType.
Property IterationNumber (p. 921) Gets the IterationNumber.
Property LoadStep (p. 921) Gets the LoadStep.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
916 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.
Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.
Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.
Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.
Property Location (p. 922) Gets or sets the Location.
Property Maximum (p. 922) Gets the Maximum.
Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.
Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.
Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.
Property Minimum (p. 923) Gets the Minimum.
Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.
Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.
Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.
Property PlotData (p. 923) Gets the result table.
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.
Property SetNumber (p. 924) Gets or sets the Set Number.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.
Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.
Property Substep (p. 924) Gets the Substep.
Property Suppressed (p. 924) Gets or sets the Suppressed.
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.
Property Time (p. 925) Gets the Time.
Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.
Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.
Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.
Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.
Method AddAlert() (p. 926) Creates a new Alert
Method AddComment() (p. 926) Creates a new child Comment.
Method AddConvergence() (p. 926) Creates a new Convergence
Method AddFigure() (p. 926) Creates a new child Figure.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 917
Ansys.ACT.Automation.Mechanical.Results Namespace

Method AddImage(string) (p. 926) Creates a new child Image. If a 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. 927) Run the ClearGeneratedData action.
Method CreateResultsAtAllSets() (p. 927) Run the CreateResultsAtAllSets action.
Method Delete() (p. 927) Run the Delete action.
Method DuplicateWithoutResults() (p. 927) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 927) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 927)
Method ExportToTextFile(string) (p. 928) Run the ExportToTextFile action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 928)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<DataModelObject>) (p. 928)
Method PromoteToNamedSelection() (p. 929) Run the PromoteToNamedSelection
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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
918 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Declaration Syntax
public IList<DataModelObject> 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. 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; }

DisplayTime
Gets or sets the DisplayTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 919
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public Quantity DisplayTime { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { 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; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
920 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

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; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 921
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public uint LoadStepForMinimumOfMaximumValues { get; }

LoadStepForMinimumOfMinimumValues
Get the Load Step for the minimum of minimum values.

Declaration Syntax
public uint LoadStepForMinimumOfMinimumValues { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

MaximumOccursOn
Gets the MaximumOccursOn.

Declaration Syntax
public string MaximumOccursOn { get; }

MaximumOfMaximumOverTime
Gets the MaximumOfMaximumOverTime.

Declaration Syntax
public Quantity MaximumOfMaximumOverTime { get; }

MaximumOfMinimumOverTime
Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
922 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Declaration Syntax
public Quantity MaximumOfMinimumOverTime { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumOccursOn
Gets the MinimumOccursOn.

Declaration Syntax
public string MinimumOccursOn { get; }

MinimumOfMaximumOverTime
Gets the MinimumOfMaximumOverTime.

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; }

RpmSetNumber
Gets or sets the RpmSetNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 923
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public uint RpmSetNumber { 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; }

Substep
Gets the Substep.

Declaration Syntax
public int Substep { get; }

Suppressed
Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
924 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Declaration Syntax
public bool Suppressed { set;get; }

TabularData
Gets the tabular data of the result. Use a to get index to each column of the tabular data.

Declaration Syntax
public ITable TabularData { 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; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 925
Ansys.ACT.Automation.Mechanical.Results Namespace

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()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
926 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateResultsAtAllSets()
Run the CreateResultsAtAllSets action.

Declaration Syntax
public virtual void CreateResultsAtAllSets()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DuplicateWithoutResults()
Run the DuplicateWithoutResults action.

Declaration Syntax
public virtual DataModelObject 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)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 927
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
928 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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()

ResultChart
Defines a ResultChart.

Declaration Syntax
public abstract class ResultChart : DataModelObject, IFolderDataModelObject

Table 274: Members

Property AccelerationType (p. 931) Gets the AccelerationType.


Property BoundaryCondition (p. 931) Gets or sets the BoundaryCondition.
Property ChartViewingStyle (p. 931) Gets or sets the ChartViewingStyle.
Property Children (p. 931) Gets the list of children.
Property Comments (p. 931) Gets the list of associated comments.
Property CoordinateSystem (p. 931) Gets or sets the CoordinateSystem.
Property CurvesAppearanceDisplay (p. 932) Gets or sets the CurvesAppearanceDisplay.
Property CutFrequency (p. 932) Gets or sets the CutFrequency.
Property DataModelObjectCategory (p. 932) Gets the current DataModelObject's category.
Property DeformationType (p. 932) Gets the DeformationType.
Property Duration (p. 932) Gets or sets the Duration.
Property EnhancedTracking (p. 932) Gets the EnhancedTracking.
Property FilterMaximum (p. 933) Gets the FilterMaximum.
Property FilterMinimum (p. 933) Gets the FilterMinimum.
Property FilterType (p. 933) Gets or sets the FilterType.
Property FrequencyAtMaximumAmplitude (p. 933) Gets the FrequencyAtMaximumAmplitude.
Property GeometrySelectionString (p. 933) Gets or sets the GeometrySelectionString.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 929
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Images (p. 933) Gets the list of associated images.


Property ImaginaryAtMaximumAmplitude (p. 934) Gets the ImaginaryAtMaximumAmplitude.
Property InternalObject (p. 934) Gets the internal object. For advanced usage only.
Property IsSolved (p. 934) Gets the IsSolved.
Property Location (p. 934) Gets or sets the Location.
Property Maximum (p. 934) Gets the Maximum.
Property MaximumAmplitude (p. 934) Gets the MaximumAmplitude.
Property MaximumFrequency (p. 935) Gets or sets the MaximumFrequency.
Property Minimum (p. 935) Gets the Minimum.
Property MinimumFrequency (p. 935) Gets or sets the MinimumFrequency.
Property NormalOrientation (p. 935) Gets or sets the NormalOrientation.
Property PhaseAngle (p. 935) Gets the PhaseAngle.
Property RealAtMaximumAmplitude (p. 935) Gets the RealAtMaximumAmplitude.
Property ReportedFrequency (p. 936) Gets the ReportedFrequency.
Property RequestedFrequency (p. 936) Gets or sets the RequestedFrequency.
Property ResultChartType (p. 936) Gets the ResultChartType.
Property RpmSetNumber (p. 936) Gets or sets the RpmSetNumber.
Property ShearOrientation (p. 936) Gets or sets the ShearOrientation.
Property SpatialResolution (p. 936) Gets or sets the SpatialResolution.
Property Spring (p. 937) Gets or sets the Spring.
Property StressStrainType (p. 937) Gets or sets the StressStrainType.
Property Suppressed (p. 937) Gets or sets the Suppressed.
Property TimeHistoryDisplay (p. 937) Gets or sets the TimeHistoryDisplay.
Property UseParentFrequencyRange (p. 937) Gets or sets the UseParentFrequencyRange.
Property VelocityType (p. 937) Gets the VelocityType.
Property XAxisValues (p. 938) Gets or sets the XAxisValues.
Method AddComment() (p. 938) Creates a new child Comment.
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 Delete() (p. 938) Run the Delete action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 938)
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 939)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 939)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
930 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

AccelerationType
Gets the AccelerationType.

Declaration Syntax
public TotalOrDirectional AccelerationType { get; }

BoundaryCondition
Gets or sets the BoundaryCondition.

Declaration Syntax
public GenericBoundaryCondition BoundaryCondition { set;get; }

ChartViewingStyle
Gets or sets the ChartViewingStyle.

Declaration Syntax
public ChartAxisScaleType ChartViewingStyle { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 931
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

DeformationType
Gets the DeformationType.

Declaration Syntax
public TotalOrDirectional DeformationType { get; }

Duration
Gets or sets the Duration.

Declaration Syntax
public Quantity Duration { set;get; }

EnhancedTracking
Gets the EnhancedTracking.

Declaration Syntax
public bool EnhancedTracking { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
932 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

FilterMaximum
Gets the FilterMaximum.

Declaration Syntax
public Quantity FilterMaximum { get; }

FilterMinimum
Gets the FilterMinimum.

Declaration Syntax
public Quantity FilterMinimum { get; }

FilterType
Gets or sets the FilterType.

Declaration Syntax
public FilterType FilterType { set;get; }

FrequencyAtMaximumAmplitude
Gets the FrequencyAtMaximumAmplitude.

Declaration Syntax
public Quantity FrequencyAtMaximumAmplitude { get; }

GeometrySelectionString
Gets or sets the GeometrySelectionString.

Declaration Syntax
public string GeometrySelectionString { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 933
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

IsSolved
Gets the IsSolved.

Declaration Syntax
public bool IsSolved { 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
934 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 935
Ansys.ACT.Automation.Mechanical.Results Namespace

ReportedFrequency
Gets the ReportedFrequency.

Declaration Syntax
public Quantity ReportedFrequency { get; }

RequestedFrequency
Gets or sets the RequestedFrequency.

Declaration Syntax
public Quantity RequestedFrequency { set;get; }

ResultChartType
Gets the ResultChartType.

Declaration Syntax
public ChartResultType ResultChartType { get; }

RpmSetNumber
Gets or sets the RpmSetNumber.

Declaration Syntax
public uint RpmSetNumber { 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
936 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Spring
Gets or sets the Spring.

Declaration Syntax
public Spring Spring { set;get; }

StressStrainType
Gets or sets the StressStrainType.

Declaration Syntax
public StressStrainType StressStrainType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TimeHistoryDisplay
Gets or sets the TimeHistoryDisplay.

Declaration Syntax
public TimeHistoryDisplayType TimeHistoryDisplay { set;get; }

UseParentFrequencyRange
Gets or sets the UseParentFrequencyRange.

Declaration Syntax
public bool UseParentFrequencyRange { set;get; }

VelocityType
Gets the VelocityType.

Declaration Syntax
public TotalOrDirectional VelocityType { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 937
Ansys.ACT.Automation.Mechanical.Results Namespace

XAxisValues
Gets or sets the XAxisValues.

Declaration Syntax
public XAxisValues XAxisValues { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ExportAnimation(string, GraphicsAnimationExportFormat, AnimationEx-


portSettings)
Run the ExportAnimation action.

Declaration Syntax
public virtual void ExportAnimation(string filePath, GraphicsAnimationExportFormat format, Anima-
tionExportSettings settings)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
938 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultTable

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ResultTable
Defines a ResultTable.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 939
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class ResultTable : DataModelObject, IFolderDataModelObject

Table 275: Members

Property Children (p. 940) Gets the list of children.


Property Comments (p. 940) Gets the list of associated comments.
Property DataModelObjectCategory (p. 940) Gets the current DataModelObject's category.
Property Images (p. 941) Gets the list of associated images.
Property InternalObject (p. 941) Gets the internal object. For advanced usage only.
Property Multiplier (p. 941) Gets or sets the Multiplier.
Method AddComment() (p. 941) Creates a new child Comment.
Method AddImage(string) (p. 941) Creates a new child Image. If a 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. 941) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 942)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 942)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> 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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
940 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultTable

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultTableAuto InternalObject { get; }

Multiplier
Gets or sets the Multiplier.

Declaration Syntax
public double Multiplier { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)
Full path of file. Defaults to None.

Delete()
Run the Delete action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 941
Ansys.ACT.Automation.Mechanical.Results 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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

ShapeFinder
Defines a ShapeFinder.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
942 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinder

Declaration Syntax
public class ShapeFinder : Result

Table 276: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 946) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 943
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 946) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
944 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinder

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 945
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 277: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
946 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinderElemental

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 949) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 950) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 947
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
948 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinderElemental

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 949
Ansys.ACT.Automation.Mechanical.Results Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Smoothing
Defines a Smoothing.

Declaration Syntax
public class Smoothing : STL

Table 278: Members

Property Children (p. 766) Gets the list of children.

(Inherited from STL (p. 765).)


Property Color (p. 766) Gets or sets the Color.

(Inherited from STL (p. 765).)


Property Comments (p. 766) Gets the list of associated comments.

(Inherited from STL (p. 765).)


Property DataModelObjectCategory (p. 951)Gets the current DataModelObject's
category.
Property Figures (p. 766) Gets the list of associated figures.

(Inherited from STL (p. 765).)


Property FileName (p. 767) Gets or sets the FileName.

(Inherited from STL (p. 765).)


Property Images (p. 767) Gets the list of associated images.

(Inherited from STL (p. 765).)


Property InternalObject (p. 951) Gets the internal object. For advanced usage
only.
Property LengthUnits (p. 767) Gets or sets the LengthUnits.

(Inherited from STL (p. 765).)


Property MoveLimit (p. 951) Gets or sets the MoveLimit.
Property ShowAlways (p. 767) Gets or sets the ShowAlways.

(Inherited from STL (p. 765).)


Property Statistics (p. 767) Gets the Statistics.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
950 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyDensity

(Inherited from STL (p. 765).)


Property Suppressed (p. 768) Gets or sets the Suppressed.

(Inherited from STL (p. 765).)


Property TranslateX (p. 768) Gets or sets the TranslateX.

(Inherited from STL (p. 765).)


Property TranslateY (p. 768) Gets or sets the TranslateY.

(Inherited from STL (p. 765).)


Property TranslateZ (p. 768) Gets or sets the TranslateZ.

(Inherited from STL (p. 765).)

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 IDSGeometryFileContainerAuto InternalObject { get; }

MoveLimit
Gets or sets the MoveLimit.

Declaration Syntax
public double MoveLimit { set;get; }

TopologyDensity
Defines a TopologyDensity.

Declaration Syntax
public class TopologyDensity : TopologyOptimizationResult

Table 279: Members

Property Children (p. 957) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 951
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Comments (p. 957) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property DataModelObjectCategory (p. 953)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 957) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Figures (p. 958) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalMass (p. 958) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalVolume (p. 958) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Images (p. 958) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property InternalObject (p. 953) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 958) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Location (p. 959) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Maximum (p. 959) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Minimum (p. 959) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalMass (p. 959) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
952 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyDensity

Property OriginalVolume (p. 959) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentMassOfOriginal (p. 959) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentVolumeOfOriginal (p. 960) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property RetainedThreshold (p. 953) Gets or sets the RetainedThreshold.
Property ShowOptimizedRegion (p. 960) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Suppressed (p. 960) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 956).)
Method InsertSmoothing() (p. 954) 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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 953
Ansys.ACT.Automation.Mechanical.Results Namespace

InsertSmoothing()
Run the InsertSmoothing action.

Declaration Syntax
public virtual void InsertSmoothing()

TopologyElementalDensity
Defines a TopologyElementalDensity.

Declaration Syntax
public class TopologyElementalDensity : TopologyOptimizationResult

Table 280: Members

Property Children (p. 957) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Comments (p. 957) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property DataModelObjectCategory (p. 955)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 957) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Figures (p. 958) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalMass (p. 958) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property FinalVolume (p. 958) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Images (p. 958) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property InternalObject (p. 956) Gets the internal object. For advanced usage
only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
954 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyElementalDensity

Property IterationNumber (p. 958) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Location (p. 959) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Maximum (p. 959) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Minimum (p. 959) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalMass (p. 959) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property OriginalVolume (p. 959) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentMassOfOriginal (p. 959) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property PercentVolumeOfOriginal (p. 960) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property RetainedThreshold (p. 956) Gets or sets the RetainedThreshold.
Property ShowOptimizedRegion (p. 960) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 956).)
Property Suppressed (p. 960) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 956).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 955
Ansys.ACT.Automation.Mechanical.Results Namespace

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 281: Members

Property Children (p. 957) Gets the list of children.


Property Comments (p. 957) Gets the list of associated comments.
Property DataModelObjectCategory (p. 957) Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 957) Gets or sets the ExclusionsParticipation.
Property Figures (p. 958) Gets the list of associated figures.
Property FinalMass (p. 958) Gets the FinalMass.
Property FinalVolume (p. 958) Gets the FinalVolume.
Property Images (p. 958) Gets the list of associated images.
Property InternalObject (p. 958) Gets the internal object. For advanced usage only.
Property IterationNumber (p. 958) Gets the IterationNumber.
Property Location (p. 959) Gets or sets the Location.
Property Maximum (p. 959) Gets the Maximum.
Property Minimum (p. 959) Gets the Minimum.
Property OriginalMass (p. 959) Gets the OriginalMass.
Property OriginalVolume (p. 959) Gets the OriginalVolume.
Property PercentMassOfOriginal (p. 959) Gets the PercentMassOfOriginal.
Property PercentVolumeOfOriginal (p. 960) Gets the PercentVolumeOfOriginal.
Property ShowOptimizedRegion (p. 960) Gets or sets the ShowOptimizedRegion.
Property Suppressed (p. 960) Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
956 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyOptimizationResult

Method AddComment() (p. 960) Creates a new child Comment.


Method AddFigure() (p. 960) Creates a new child Figure.
Method AddImage(string) (p. 960) Creates a new child Image. If a 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. 961) Clears the result.
Method Delete() (p. 961) Run the Delete action.
Method EvaluateAllResults() (p. 961) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 961)
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 962)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 962)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ExclusionsParticipation
Gets or sets the ExclusionsParticipation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 957
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public bool ExclusionsParticipation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FinalMass
Gets the FinalMass.

Declaration Syntax
public Quantity FinalMass { get; }

FinalVolume
Gets the FinalVolume.

Declaration Syntax
public Quantity FinalVolume { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

IterationNumber
Gets the IterationNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
958 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyOptimizationResult

Declaration Syntax
public int IterationNumber { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public double Minimum { get; }

OriginalMass
Gets the OriginalMass.

Declaration Syntax
public Quantity OriginalMass { get; }

OriginalVolume
Gets the OriginalVolume.

Declaration Syntax
public Quantity OriginalVolume { get; }

PercentMassOfOriginal
Gets the PercentMassOfOriginal.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 959
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public double PercentMassOfOriginal { get; }

PercentVolumeOfOriginal
Gets the PercentVolumeOfOriginal.

Declaration Syntax
public double PercentVolumeOfOriginal { 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()

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
960 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyOptimizationResult

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()

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 961
Ansys.ACT.Automation.Mechanical.Results Namespace

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

UserDefinedResult
Defines a UserDefinedResult.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
962 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public class UserDefinedResult : DataModelObject, IFolderDataModelObject

Table 282: Members

Property Average (p. 964) Gets the Average.


Property AverageAcrossBodies (p. 964) Gets or sets the AverageAcrossBodies.
Property By (p. 965) Gets or sets the By.
Property CalculateTimeHistory (p. 965) Gets or sets the CalculateTimeHistory.
Property Children (p. 965) Gets the list of children.
Property CombinationNumber (p. 965) Gets or sets the Combination Number for a Solution
Combination result.
Property CoordinateSystem (p. 965) Gets or sets the CoordinateSystem.
Property CyclicMode (p. 965) Gets or sets the CyclicMode.
Property DataModelObjectCategory (p. 966) Gets the current DataModelObject's category.
Property DisplayOption (p. 966) Gets or sets the DisplayOption.
Property DisplayTime (p. 966) Gets or sets the DisplayTime.
Property Expression (p. 966) Gets or sets the Expression.
Property GraphControlsXAxis (p. 966) Gets or sets the GraphControlsXAxis.
Property Identifier (p. 966) Gets or sets the Identifier.
Property InputUnitSystem (p. 967) Gets the InputUnitSystem.
Property InternalObject (p. 967) Gets the internal object. For advanced usage only.
Property IsSolved (p. 967) Gets the IsSolved.
Property ItemType (p. 967) Gets or sets the ItemType.
Property IterationNumber (p. 967) Gets the IterationNumber.
Property Layer (p. 967) Gets or sets the Layer.
Property LoadMultiplier (p. 968) Gets the LoadMultiplier.
Property LoadStep (p. 968) Gets the LoadStep.
Property Location (p. 968) Gets or sets the Location.
Property Maximum (p. 968) Gets the Maximum.
Property MaximumOccursOn (p. 968) Gets the MaximumOccursOn.
Property MaximumOfMaximumOverTime (p. 968) Gets the MaximumOfMaximumOverTime.
Property MaximumOfMinimumOverTime (p. 969) Gets the MaximumOfMinimumOverTime.
Property Minimum (p. 969) Gets the Minimum.
Property MinimumOccursOn (p. 969) Gets the MinimumOccursOn.
Property MinimumOfMaximumOverTime (p. 969) Gets the MinimumOfMaximumOverTime.
Property MinimumOfMinimumOverTime (p. 969) Gets the MinimumOfMinimumOverTime.
Property Mode (p. 969) Gets or sets the Mode (Result Set Number).
Property OutputUnit (p. 970) Gets or sets the OutputUnit.
Property PlotData (p. 970) Gets the result table.
Property Ply (p. 970) Gets or sets the Ply selection.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 963
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Position (p. 970) Gets or sets the Position.


Property ReportedFrequency (p. 970) Gets the ReportedFrequency.
Property RequestedFrequency (p. 970) Gets or sets the RequestedFrequency.
Property ResponseType (p. 971) Gets or sets the ResponseType.
Property RpmSetNumber (p. 971) Gets or sets the RpmSetNumber.
Property ScaleFactor (p. 971) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 971) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 971) Gets or sets the ScopingMethod.
Property SetNumber (p. 971) Gets or sets the Set Number.
Property SolutionCombinationDriver (p. 972) Gets or sets the SolutionCombinationDriver.
Property SolverComponentIDs (p. 972) Gets or sets the SolverComponentIDs.
Property SubScopeBy (p. 972) Gets or sets the SubScopeBy.
Property Substep (p. 972) Gets the Substep.
Property Suppressed (p. 972) Gets or sets the Suppressed.
Property SweepingPhase (p. 972) Gets or sets the SweepingPhase.
Property Time (p. 973) Gets the Time.
Property Type (p. 973) Gets the Type.
Method ClearGeneratedData() (p. 973) Run the ClearGeneratedData action.
Method CreateResultsAtAllSets() (p. 973) Run the CreateResultsAtAllSets action.
Method Delete() (p. 973) Run the Delete action.
Method DuplicateWithoutResults() (p. 973) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 974) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 974)
Method ExportToTextFile(string) (p. 974) Run the ExportToTextFile action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 974)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 975)
Method PromoteToNamedSelection() (p. 975) Run the PromoteToNamedSelection action.

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
964 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<DataModelObject> 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 CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CyclicMode
Gets or sets the CyclicMode.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 965
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

GraphControlsXAxis
Gets or sets the GraphControlsXAxis.

Declaration Syntax
public GraphControlsXAxis GraphControlsXAxis { set;get; }

Identifier
Gets or sets the Identifier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
966 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

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; }

IterationNumber
Gets the IterationNumber.

Declaration Syntax
public int IterationNumber { get; }

Layer
Gets or sets the Layer.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 967
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

MaximumOccursOn
Gets the MaximumOccursOn.

Declaration Syntax
public string MaximumOccursOn { get; }

MaximumOfMaximumOverTime
Gets the MaximumOfMaximumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
968 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public Quantity MaximumOfMaximumOverTime { get; }

MaximumOfMinimumOverTime
Gets the MaximumOfMinimumOverTime.

Declaration Syntax
public Quantity MaximumOfMinimumOverTime { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumOccursOn
Gets the MinimumOccursOn.

Declaration Syntax
public string MinimumOccursOn { get; }

MinimumOfMaximumOverTime
Gets the MinimumOfMaximumOverTime.

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).

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 969
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public uint Mode { set;get; }

OutputUnit
Gets or sets the OutputUnit.

Declaration Syntax
public UnitCategoryType OutputUnit { set;get; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
970 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public Quantity RequestedFrequency { set;get; }

ResponseType
Gets or sets the ResponseType.

Declaration Syntax
public CoreResultType ResponseType { set;get; }

RpmSetNumber
Gets or sets the RpmSetNumber.

Declaration Syntax
public uint RpmSetNumber { set;get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public ScaleFactorType ScaleFactor { set;get; }

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Declaration Syntax
public double ScaleFactorValue { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SetNumber
Gets or sets the Set Number.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 971
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
972 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

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; }

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateResultsAtAllSets()
Run the CreateResultsAtAllSets action.

Declaration Syntax
public virtual void CreateResultsAtAllSets()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DuplicateWithoutResults()
Run the DuplicateWithoutResults action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 973
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public virtual DataModelObject 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)

Parameters
filePath(string)
No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
974 of ANSYS, Inc. and its subsidiaries and affiliates.
VariableGraph

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
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()

VariableGraph
Defines a VariableGraph.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 975
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class VariableGraph : Result

Table 283: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 979) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
976 of ANSYS, Inc. and its subsidiaries and affiliates.
VariableGraph

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 979) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 977
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
978 of ANSYS, Inc. and its subsidiaries and affiliates.
Volume

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 284: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 979
Ansys.ACT.Automation.Mechanical.Results Namespace

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 982) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 983) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
980 of ANSYS, Inc. and its subsidiaries and affiliates.
Volume

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 981
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
982 of ANSYS, Inc. and its subsidiaries and affiliates.
Volume

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 983
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
984 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 285: Members

AccelerationPhaseResponse (p. 985) Defines a


AccelerationPhaseResponse.
DeformationPhaseResponse (p. 988) Defines a
DeformationPhaseResponse.
ElasticStrainPhaseResponse (p. 992) Defines a
ElasticStrainPhaseResponse.
StressPhaseResponse (p. 995) Defines a StressPhaseResponse.
VelocityPhaseResponse (p. 998) Defines a
VelocityPhaseResponse.

AccelerationPhaseResponse
Defines a AccelerationPhaseResponse.

Declaration Syntax
public class AccelerationPhaseResponse : ResultChart

Table 286: Members

Property AccelerationType (p. 931) Gets the AccelerationType.

(Inherited from ResultChart (p. 929).)


Property BoundaryCondition (p. 931) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 929).)


Property ChartViewingStyle (p. 931) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 929).)


Property Children (p. 931) Gets the list of children.

(Inherited from ResultChart (p. 929).)


Property Comments (p. 931) Gets the list of associated comments.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 985
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 929).)


Property ContactRegion (p. 988) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 931) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 929).)


Property CurvesAppearanceDisplay (p. 932) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 929).)


Property CutFrequency (p. 932) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 929).)


Property DataModelObjectCategory (p. 988) Gets the current DataModelObject's
category.
Property DeformationType (p. 932) Gets the DeformationType.

(Inherited from ResultChart (p. 929).)


Property Duration (p. 932) Gets or sets the Duration.

(Inherited from ResultChart (p. 929).)


Property EnhancedTracking (p. 932) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 929).)


Property FilterMaximum (p. 933) Gets the FilterMaximum.

(Inherited from ResultChart (p. 929).)


Property FilterMinimum (p. 933) Gets the FilterMinimum.

(Inherited from ResultChart (p. 929).)


Property FilterType (p. 933) Gets or sets the FilterType.

(Inherited from ResultChart (p. 929).)


Property FrequencyAtMaximumAmplitude (p. 933) Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property GeometrySelectionString (p. 933) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 929).)


Property Images (p. 933) Gets the list of associated images.

(Inherited from ResultChart (p. 929).)


Property ImaginaryAtMaximumAmplitude (p. 934) Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property InternalObject (p. 988) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 934) Gets the IsSolved.

(Inherited from ResultChart (p. 929).)


Property Location (p. 934) Gets or sets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
986 of ANSYS, Inc. and its subsidiaries and affiliates.
AccelerationPhaseResponse

(Inherited from ResultChart (p. 929).)


Property Maximum (p. 934) Gets the Maximum.

(Inherited from ResultChart (p. 929).)


Property MaximumAmplitude (p. 934) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property MaximumFrequency (p. 935) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 929).)


Property Minimum (p. 935) Gets the Minimum.

(Inherited from ResultChart (p. 929).)


Property MinimumFrequency (p. 935) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 929).)


Property NormalOrientation (p. 935) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 929).)


Property PhaseAngle (p. 935) Gets the PhaseAngle.

(Inherited from ResultChart (p. 929).)


Property RealAtMaximumAmplitude (p. 935) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property ReportedFrequency (p. 936) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 929).)


Property RequestedFrequency (p. 936) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 929).)


Property ResultChartType (p. 936) Gets the ResultChartType.

(Inherited from ResultChart (p. 929).)


Property RpmSetNumber (p. 936) Gets or sets the RpmSetNumber.

(Inherited from ResultChart (p. 929).)


Property ShearOrientation (p. 936) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 929).)


Property SpatialResolution (p. 936) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 929).)


Property Spring (p. 937) Gets or sets the Spring.

(Inherited from ResultChart (p. 929).)


Property StressStrainType (p. 937) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 929).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 987
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property Suppressed (p. 937) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 929).)


Property TimeHistoryDisplay (p. 937) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 929).)


Property UseParentFrequencyRange (p. 937) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 929).)


Property VelocityType (p. 937) Gets the VelocityType.

(Inherited from ResultChart (p. 929).)


Property XAxisValues (p. 938) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 929).)

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; }

DeformationPhaseResponse
Defines a DeformationPhaseResponse.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
988 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationPhaseResponse

Declaration Syntax
public class DeformationPhaseResponse : ResultChart

Table 287: Members

Property AccelerationType (p. 931) Gets the AccelerationType.

(Inherited from ResultChart (p. 929).)


Property BoundaryCondition (p. 931) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 929).)


Property ChartViewingStyle (p. 931) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 929).)


Property Children (p. 931) Gets the list of children.

(Inherited from ResultChart (p. 929).)


Property Comments (p. 931) Gets the list of associated comments.

(Inherited from ResultChart (p. 929).)


Property CoordinateSystem (p. 931) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 929).)


Property CurvesAppearanceDisplay (p. 932) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 929).)


Property CutFrequency (p. 932) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 929).)


Property DataModelObjectCategory (p. 991) Gets the current DataModelObject's
category.
Property DeformationType (p. 932) Gets the DeformationType.

(Inherited from ResultChart (p. 929).)


Property Duration (p. 932) Gets or sets the Duration.

(Inherited from ResultChart (p. 929).)


Property EnhancedTracking (p. 932) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 929).)


Property FilterMaximum (p. 933) Gets the FilterMaximum.

(Inherited from ResultChart (p. 929).)


Property FilterMinimum (p. 933) Gets the FilterMinimum.

(Inherited from ResultChart (p. 929).)


Property FilterType (p. 933) Gets or sets the FilterType.

(Inherited from ResultChart (p. 929).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 989
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property FrequencyAtMaximumAmplitude (p. 933) Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property GeometrySelectionString (p. 933) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 929).)


Property Images (p. 933) Gets the list of associated images.

(Inherited from ResultChart (p. 929).)


Property ImaginaryAtMaximumAmplitude (p. 934) Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property InternalObject (p. 991) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 934) Gets the IsSolved.

(Inherited from ResultChart (p. 929).)


Property Location (p. 934) Gets or sets the Location.

(Inherited from ResultChart (p. 929).)


Property Maximum (p. 934) Gets the Maximum.

(Inherited from ResultChart (p. 929).)


Property MaximumAmplitude (p. 934) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property MaximumFrequency (p. 935) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 929).)


Property Minimum (p. 935) Gets the Minimum.

(Inherited from ResultChart (p. 929).)


Property MinimumFrequency (p. 935) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 929).)


Property NormalOrientation (p. 935) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 929).)


Property PhaseAngle (p. 935) Gets the PhaseAngle.

(Inherited from ResultChart (p. 929).)


Property RealAtMaximumAmplitude (p. 935) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property ReportedFrequency (p. 936) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 929).)


Property RequestedFrequency (p. 936) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 929).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
990 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationPhaseResponse

Property ResultChartType (p. 936) Gets the ResultChartType.

(Inherited from ResultChart (p. 929).)


Property RpmSetNumber (p. 936) Gets or sets the RpmSetNumber.

(Inherited from ResultChart (p. 929).)


Property ShearOrientation (p. 936) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 929).)


Property SpatialResolution (p. 936) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 929).)


Property Spring (p. 937) Gets or sets the Spring.

(Inherited from ResultChart (p. 929).)


Property StressStrainType (p. 937) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 929).)


Property Suppressed (p. 937) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 929).)


Property TimeHistoryDisplay (p. 937) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 929).)


Property UseParentFrequencyRange (p. 937) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 929).)


Property VelocityType (p. 937) Gets the VelocityType.

(Inherited from ResultChart (p. 929).)


Property XAxisValues (p. 938) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 929).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 991
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

ElasticStrainPhaseResponse
Defines a ElasticStrainPhaseResponse.

Declaration Syntax
public class ElasticStrainPhaseResponse : ResultChart

Table 288: Members

Property AccelerationType (p. 931) Gets the AccelerationType.

(Inherited from ResultChart (p. 929).)


Property BoundaryCondition (p. 931) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 929).)


Property ChartViewingStyle (p. 931) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 929).)


Property Children (p. 931) Gets the list of children.

(Inherited from ResultChart (p. 929).)


Property Comments (p. 931) Gets the list of associated comments.

(Inherited from ResultChart (p. 929).)


Property ContactRegion (p. 994) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 931) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 929).)


Property CurvesAppearanceDisplay (p. 932) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 929).)


Property CutFrequency (p. 932) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 929).)


Property DataModelObjectCategory (p. 994) Gets the current DataModelObject's
category.
Property DeformationType (p. 932) Gets the DeformationType.

(Inherited from ResultChart (p. 929).)


Property Duration (p. 932) Gets or sets the Duration.

(Inherited from ResultChart (p. 929).)


Property EnhancedTracking (p. 932) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 929).)


Property FilterMaximum (p. 933) Gets the FilterMaximum.

(Inherited from ResultChart (p. 929).)


Property FilterMinimum (p. 933) Gets the FilterMinimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
992 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainPhaseResponse

(Inherited from ResultChart (p. 929).)


Property FilterType (p. 933) Gets or sets the FilterType.

(Inherited from ResultChart (p. 929).)


Property FrequencyAtMaximumAmplitude (p. 933) Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property GeometrySelectionString (p. 933) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 929).)


Property Images (p. 933) Gets the list of associated images.

(Inherited from ResultChart (p. 929).)


Property ImaginaryAtMaximumAmplitude (p. 934) Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property InternalObject (p. 995) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 934) Gets the IsSolved.

(Inherited from ResultChart (p. 929).)


Property Location (p. 934) Gets or sets the Location.

(Inherited from ResultChart (p. 929).)


Property Maximum (p. 934) Gets the Maximum.

(Inherited from ResultChart (p. 929).)


Property MaximumAmplitude (p. 934) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property MaximumFrequency (p. 935) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 929).)


Property Minimum (p. 935) Gets the Minimum.

(Inherited from ResultChart (p. 929).)


Property MinimumFrequency (p. 935) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 929).)


Property NormalOrientation (p. 935) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 929).)


Property PhaseAngle (p. 935) Gets the PhaseAngle.

(Inherited from ResultChart (p. 929).)


Property RealAtMaximumAmplitude (p. 935) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property ReportedFrequency (p. 936) Gets the ReportedFrequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 993
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 929).)


Property RequestedFrequency (p. 936) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 929).)


Property ResultChartType (p. 936) Gets the ResultChartType.

(Inherited from ResultChart (p. 929).)


Property RpmSetNumber (p. 936) Gets or sets the RpmSetNumber.

(Inherited from ResultChart (p. 929).)


Property ShearOrientation (p. 936) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 929).)


Property SpatialResolution (p. 936) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 929).)


Property Spring (p. 937) Gets or sets the Spring.

(Inherited from ResultChart (p. 929).)


Property StressStrainType (p. 937) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 929).)


Property Suppressed (p. 937) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 929).)


Property TimeHistoryDisplay (p. 937) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 929).)


Property UseParentFrequencyRange (p. 937) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 929).)


Property VelocityType (p. 937) Gets the VelocityType.

(Inherited from ResultChart (p. 929).)


Property XAxisValues (p. 938) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 929).)

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
994 of ANSYS, Inc. and its subsidiaries and affiliates.
StressPhaseResponse

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

StressPhaseResponse
Defines a StressPhaseResponse.

Declaration Syntax
public class StressPhaseResponse : ResultChart

Table 289: Members

Property AccelerationType (p. 931) Gets the AccelerationType.

(Inherited from ResultChart (p. 929).)


Property BoundaryCondition (p. 931) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 929).)


Property ChartViewingStyle (p. 931) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 929).)


Property Children (p. 931) Gets the list of children.

(Inherited from ResultChart (p. 929).)


Property Comments (p. 931) Gets the list of associated comments.

(Inherited from ResultChart (p. 929).)


Property CoordinateSystem (p. 931) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 929).)


Property CurvesAppearanceDisplay (p. 932) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 929).)


Property CutFrequency (p. 932) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 929).)


Property DataModelObjectCategory (p. 998) Gets the current DataModelObject's
category.
Property DeformationType (p. 932) Gets the DeformationType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 995
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 929).)


Property Duration (p. 932) Gets or sets the Duration.

(Inherited from ResultChart (p. 929).)


Property EnhancedTracking (p. 932) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 929).)


Property FilterMaximum (p. 933) Gets the FilterMaximum.

(Inherited from ResultChart (p. 929).)


Property FilterMinimum (p. 933) Gets the FilterMinimum.

(Inherited from ResultChart (p. 929).)


Property FilterType (p. 933) Gets or sets the FilterType.

(Inherited from ResultChart (p. 929).)


Property FrequencyAtMaximumAmplitude (p. 933) Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property GeometrySelectionString (p. 933) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 929).)


Property Images (p. 933) Gets the list of associated images.

(Inherited from ResultChart (p. 929).)


Property ImaginaryAtMaximumAmplitude (p. 934) Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property InternalObject (p. 998) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 934) Gets the IsSolved.

(Inherited from ResultChart (p. 929).)


Property Location (p. 934) Gets or sets the Location.

(Inherited from ResultChart (p. 929).)


Property Maximum (p. 934) Gets the Maximum.

(Inherited from ResultChart (p. 929).)


Property MaximumAmplitude (p. 934) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property MaximumFrequency (p. 935) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 929).)


Property Minimum (p. 935) Gets the Minimum.

(Inherited from ResultChart (p. 929).)


Property MinimumFrequency (p. 935) Gets or sets the MinimumFrequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
996 of ANSYS, Inc. and its subsidiaries and affiliates.
StressPhaseResponse

(Inherited from ResultChart (p. 929).)


Property NormalOrientation (p. 935) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 929).)


Property PhaseAngle (p. 935) Gets the PhaseAngle.

(Inherited from ResultChart (p. 929).)


Property RealAtMaximumAmplitude (p. 935) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property ReportedFrequency (p. 936) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 929).)


Property RequestedFrequency (p. 936) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 929).)


Property ResultChartType (p. 936) Gets the ResultChartType.

(Inherited from ResultChart (p. 929).)


Property RpmSetNumber (p. 936) Gets or sets the RpmSetNumber.

(Inherited from ResultChart (p. 929).)


Property ShearOrientation (p. 936) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 929).)


Property SpatialResolution (p. 936) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 929).)


Property Spring (p. 937) Gets or sets the Spring.

(Inherited from ResultChart (p. 929).)


Property StressStrainType (p. 937) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 929).)


Property Suppressed (p. 937) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 929).)


Property TimeHistoryDisplay (p. 937) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 929).)


Property UseParentFrequencyRange (p. 937) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 929).)


Property VelocityType (p. 937) Gets the VelocityType.

(Inherited from ResultChart (p. 929).)


Property XAxisValues (p. 938) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 929).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 997
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults 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 IDSResultChartAuto InternalObject { get; }

VelocityPhaseResponse
Defines a VelocityPhaseResponse.

Declaration Syntax
public class VelocityPhaseResponse : ResultChart

Table 290: Members

Property AccelerationType (p. 931) Gets the AccelerationType.

(Inherited from ResultChart (p. 929).)


Property BoundaryCondition (p. 931) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 929).)


Property ChartViewingStyle (p. 931) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 929).)


Property Children (p. 931) Gets the list of children.

(Inherited from ResultChart (p. 929).)


Property Comments (p. 931) Gets the list of associated comments.

(Inherited from ResultChart (p. 929).)


Property ContactRegion (p. 1001) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 931) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 929).)


Property CurvesAppearanceDisplay (p. 932) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 929).)


Property CutFrequency (p. 932) Gets or sets the CutFrequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
998 of ANSYS, Inc. and its subsidiaries and affiliates.
VelocityPhaseResponse

(Inherited from ResultChart (p. 929).)


Property DataModelObjectCategory (p. 1001) Gets the current DataModelObject's
category.
Property DeformationType (p. 932) Gets the DeformationType.

(Inherited from ResultChart (p. 929).)


Property Duration (p. 932) Gets or sets the Duration.

(Inherited from ResultChart (p. 929).)


Property EnhancedTracking (p. 932) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 929).)


Property FilterMaximum (p. 933) Gets the FilterMaximum.

(Inherited from ResultChart (p. 929).)


Property FilterMinimum (p. 933) Gets the FilterMinimum.

(Inherited from ResultChart (p. 929).)


Property FilterType (p. 933) Gets or sets the FilterType.

(Inherited from ResultChart (p. 929).)


Property FrequencyAtMaximumAmplitude (p. 933) Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property GeometrySelectionString (p. 933) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 929).)


Property Images (p. 933) Gets the list of associated images.

(Inherited from ResultChart (p. 929).)


Property ImaginaryAtMaximumAmplitude (p. 934) Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property InternalObject (p. 1001) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 934) Gets the IsSolved.

(Inherited from ResultChart (p. 929).)


Property Location (p. 934) Gets or sets the Location.

(Inherited from ResultChart (p. 929).)


Property Maximum (p. 934) Gets the Maximum.

(Inherited from ResultChart (p. 929).)


Property MaximumAmplitude (p. 934) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property MaximumFrequency (p. 935) Gets or sets the MaximumFrequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 999
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 929).)


Property Minimum (p. 935) Gets the Minimum.

(Inherited from ResultChart (p. 929).)


Property MinimumFrequency (p. 935) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 929).)


Property NormalOrientation (p. 935) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 929).)


Property PhaseAngle (p. 935) Gets the PhaseAngle.

(Inherited from ResultChart (p. 929).)


Property RealAtMaximumAmplitude (p. 935) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 929).)


Property ReportedFrequency (p. 936) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 929).)


Property RequestedFrequency (p. 936) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 929).)


Property ResultChartType (p. 936) Gets the ResultChartType.

(Inherited from ResultChart (p. 929).)


Property RpmSetNumber (p. 936) Gets or sets the RpmSetNumber.

(Inherited from ResultChart (p. 929).)


Property ShearOrientation (p. 936) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 929).)


Property SpatialResolution (p. 936) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 929).)


Property Spring (p. 937) Gets or sets the Spring.

(Inherited from ResultChart (p. 929).)


Property StressStrainType (p. 937) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 929).)


Property Suppressed (p. 937) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 929).)


Property TimeHistoryDisplay (p. 937) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 929).)


Property UseParentFrequencyRange (p. 937) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 929).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1000 of ANSYS, Inc. and its subsidiaries and affiliates.
VelocityPhaseResponse

Property VelocityType (p. 937) Gets the VelocityType.

(Inherited from ResultChart (p. 929).)


Property XAxisValues (p. 938) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 929).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1001
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1002 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 291: Members

AccumulatedEquivalentPlasticStrain (p. 1003) Defines a


AccumulatedEquivalentPlasticStrain.
DirectionalThermalStrain (p. 1008) Defines a DirectionalThermalStrain.
ElasticStrainIntensity (p. 1013) Defines a ElasticStrainIntensity.
EquivalentCreepStrain (p. 1017) Defines a EquivalentCreepStrain.
EquivalentCreepStrainRST (p. 1021) Defines a EquivalentCreepStrainRST.
EquivalentElasticStrain (p. 1026) Defines a EquivalentElasticStrain.
EquivalentElasticStrainRST (p. 1030) Defines a EquivalentElasticStrainRST.
EquivalentPlasticStrain (p. 1035) Defines a EquivalentPlasticStrain.
EquivalentPlasticStrainRST (p. 1039) Defines a EquivalentPlasticStrainRST.
EquivalentTotalStrain (p. 1044) Defines a EquivalentTotalStrain.
MaximumPrincipalElasticStrain (p. 1048) Defines a MaximumPrincipalElasticStrain.
MaximumPrincipalThermalStrain (p. 1053) Defines a
MaximumPrincipalThermalStrain.
MaximumShearElasticStrain (p. 1058) Defines a MaximumShearElasticStrain.
MiddlePrincipalElasticStrain (p. 1062) Defines a MiddlePrincipalElasticStrain.
MiddlePrincipalThermalStrain (p. 1067) Defines a MiddlePrincipalThermalStrain.
MinimumPrincipalElasticStrain (p. 1071) Defines a MinimumPrincipalElasticStrain.
NormalElasticStrain (p. 1076) Defines a NormalElasticStrain.
ShearElasticStrain (p. 1081) Defines a ShearElasticStrain.
StrainResult (p. 1086) Defines a StrainResult.
VectorPrincipalElasticStrain (p. 1092) Defines a VectorPrincipalElasticStrain.

AccumulatedEquivalentPlasticStrain
Defines a AccumulatedEquivalentPlasticStrain.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1003
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class AccumulatedEquivalentPlasticStrain : StrainResult

Table 292: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1008) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1004 of ANSYS, Inc. and its subsidiaries and affiliates.
AccumulatedEquivalentPlasticStrain

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1008) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1005
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1006 of ANSYS, Inc. and its subsidiaries and affiliates.
AccumulatedEquivalentPlasticStrain

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1007
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)

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 293: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1008 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalStrain

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1012) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1012) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1009
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1010 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalStrain

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property NormalOrientation (p. 1012) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1011
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1012 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainIntensity

ElasticStrainIntensity
Defines a ElasticStrainIntensity.

Declaration Syntax
public class ElasticStrainIntensity : StrainResult

Table 294: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1017) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1013
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1017) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1014 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainIntensity

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1015
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1016 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrain

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 295: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1017
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1021) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1021) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1018 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrain

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1019
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1020 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrainRST

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1021
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class EquivalentCreepStrainRST : StrainResult

Table 296: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1026) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1022 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrainRST

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1026) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1023
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1024 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrainRST

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1025
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)

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 297: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1026 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrain

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1030) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1030) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1027
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1028 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrain

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1029
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1030 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrainRST

Declaration Syntax
public class EquivalentElasticStrainRST : StrainResult

Table 298: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1035) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1031
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1035) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1032 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrainRST

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1033
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1034 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrain

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EquivalentPlasticStrain
Defines a EquivalentPlasticStrain.

Declaration Syntax
public class EquivalentPlasticStrain : StrainResult

Table 299: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1035
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1039) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1039) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1036 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrain

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1037
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1038 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrainRST

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

EquivalentPlasticStrainRST
Defines a EquivalentPlasticStrainRST.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1039
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class EquivalentPlasticStrainRST : StrainResult

Table 300: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1044) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1040 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrainRST

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1044) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1041
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1042 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrainRST

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1043
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)

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.

Declaration Syntax
public class EquivalentTotalStrain : StrainResult

Table 301: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1044 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentTotalStrain

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1048) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1048) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1045
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1046 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentTotalStrain

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1047
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1048 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalElasticStrain

Declaration Syntax
public class MaximumPrincipalElasticStrain : StrainResult

Table 302: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1053) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1049
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1053) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1053) Gets or sets the Layer.
Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1050 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalElasticStrain

Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property NormalOrientation (p. 1053) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1051
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1052 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalThermalStrain

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

MaximumPrincipalThermalStrain
Defines a MaximumPrincipalThermalStrain.

Declaration Syntax
public class MaximumPrincipalThermalStrain : StrainResult

Table 303: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1053
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1057) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1054 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalThermalStrain

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1058) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1055
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1056 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalThermalStrain

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1057
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MaximumShearElasticStrain
Defines a MaximumShearElasticStrain.

Declaration Syntax
public class MaximumShearElasticStrain : StrainResult

Table 304: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1058 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumShearElasticStrain

Accepts/Returns None for Fiber


Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1062) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1062) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1059
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1060 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumShearElasticStrain

Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property ShearOrientation (p. 1062) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1061
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1062 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalElasticStrain

Declaration Syntax
public class MiddlePrincipalElasticStrain : StrainResult

Table 305: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1067) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1063
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1067) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1064 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalElasticStrain

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1065
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1066 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalThermalStrain

(Inherited from Result (p. 916).)

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 306: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1067
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1071) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1071) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1068 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalThermalStrain

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1069
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1070 of ANSYS, Inc. and its subsidiaries and affiliates.
MinimumPrincipalElasticStrain

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1071
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class MinimumPrincipalElasticStrain : StrainResult

Table 307: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1076) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1072 of ANSYS, Inc. and its subsidiaries and affiliates.
MinimumPrincipalElasticStrain

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1076) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1073
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1074 of ANSYS, Inc. and its subsidiaries and affiliates.
MinimumPrincipalElasticStrain

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1075
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)

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 308: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1076 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalElasticStrain

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1080) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1080) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1077
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1078 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalElasticStrain

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property NormalOrientation (p. 1080) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1081) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1081) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1079
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1080 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearElasticStrain

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public ScaleFactorType ScaleFactor { set;get; }

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Declaration Syntax
public double ScaleFactorValue { set;get; }

ShearElasticStrain
Defines a ShearElasticStrain.

Declaration Syntax
public class ShearElasticStrain : StrainResult

Table 309: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1081
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1085) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1085) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1082 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearElasticStrain

Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1083
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1086) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1086) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property ShearOrientation (p. 1086) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1084 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearElasticStrain

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1085
Ansys.ACT.Automation.Mechanical.Results.StrainResults 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; }

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 310: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1086 of ANSYS, Inc. and its subsidiaries and affiliates.
StrainResult

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.
Property DataModelObjectCategory (p. 1090) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.
Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1091) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1087
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.
Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1088 of ANSYS, Inc. and its subsidiaries and affiliates.
StrainResult

Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.
Property Position (p. 1092) Gets or sets the Position.
Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.
Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1089
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

Frequency
Gets or sets the Frequency.

Declaration Syntax
public Quantity Frequency { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1090 of ANSYS, Inc. and its subsidiaries and affiliates.
StrainResult

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; }

LoadMultiplier
Gets the LoadMultiplier.

Declaration Syntax
public double LoadMultiplier { get; }

Mode
Gets or sets the Mode.

Declaration Syntax
public uint Mode { set;get; }

PhaseIncrement
Gets or sets the PhaseIncrement.

Declaration Syntax
public Quantity PhaseIncrement { set;get; }

Ply
Gets or sets the Ply selection.

Declaration Syntax
public IEnumerable<AnalysisPly> Ply { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1091
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

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.

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1092 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorPrincipalElasticStrain

Declaration Syntax
public class VectorPrincipalElasticStrain : StrainResult

Table 311: Members

Property Amplitude (p. 1090) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1086).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1090) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1086).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1090) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1086).)


Property DataModelObjectCategory (p. 1097) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1093
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1090) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1086).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1091) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1086).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1097) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1091) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1086).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1094 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorPrincipalElasticStrain

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1091) Gets or sets the Mode.

(Inherited from StrainResult (p. 1086).)


Property PhaseIncrement (p. 1091) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1086).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1091) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1086).)


Property Position (p. 1092) Gets or sets the Position.

(Inherited from StrainResult (p. 1086).)


Property ReportedFrequency (p. 1092) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1086).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1095
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1092) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1086).)


Property SubScopeBy (p. 1092) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1086).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1092) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1086).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1096 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorPrincipalElasticStrain

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1097
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1098 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 312: Members

DeformationResult (p. 1099) Defines a DeformationResult.


DirectionalAcceleration (p. 1107) Defines a
DirectionalAcceleration.
DirectionalAccelerationPSD (p. 1112) Defines a
DirectionalAccelerationPSD.
DirectionalAccelerationRS (p. 1117) Defines a
DirectionalAccelerationRS.
DirectionalDeformation (p. 1122) Defines a
DirectionalDeformation.
DirectionalVelocity (p. 1127) Defines a DirectionalVelocity.
DirectionalVelocityPSD (p. 1132) Defines a
DirectionalVelocityPSD.
DirectionalVelocityRS (p. 1137) Defines a DirectionalVelocityRS.
TotalAcceleration (p. 1143) Defines a TotalAcceleration.
TotalDeformation (p. 1147) Defines a TotalDeformation.
TotalVelocity (p. 1152) Defines a TotalVelocity.
VectorDeformation (p. 1157) Defines a VectorDeformation.

DeformationResult
Defines a DeformationResult.

Declaration Syntax
public abstract class DeformationResult : Result

Table 313: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.
Property Amplitude (p. 1103) Gets or sets the Amplitude.
Property Average (p. 918) Gets the Average.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1099
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.
Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.
Property DampedFrequency (p. 1104) Gets the DampedFrequency.
Property DataModelObjectCategory (p. 1104) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.
Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1100 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationResult

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1105) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.
Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1101
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.
Property Mode (p. 1105) Gets or sets the Mode.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.
Property Reference (p. 1106) Gets the Reference.
Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1102 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationResult

Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

AccelerationInG
Gets or sets the AccelerationInG.

Declaration Syntax
public bool AccelerationInG { set;get; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1103
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

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; }

DeformationType
Gets or sets the DeformationType.

Declaration Syntax
public TotalOrDirectional DeformationType { set;get; }

Frequency
Gets or sets the Frequency.

Declaration Syntax
public Quantity Frequency { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1104 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationResult

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; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1105
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

PhaseIncrement
Gets or sets the PhaseIncrement.

Declaration Syntax
public Quantity PhaseIncrement { set;get; }

Probability
Gets the Probability.

Declaration Syntax
public double Probability { get; }

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1106 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAcceleration

Stability
Gets the Stability.

Declaration Syntax
public Quantity Stability { get; }

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

DirectionalAcceleration
Defines a DirectionalAcceleration.

Declaration Syntax
public class DirectionalAcceleration : DeformationResult

Table 314: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1107
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1111) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1108 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAcceleration

Property InternalObject (p. 1112) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1109
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property NormalOrientation (p. 1112) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1110 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAcceleration

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1111
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

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 315: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1112 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAccelerationPSD

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1117) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1113
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1117) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1114 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAccelerationPSD

Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property NormalOrientation (p. 1117) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1115
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1116 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAccelerationRS

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.

Declaration Syntax
public class DirectionalAccelerationRS : DeformationResult

Table 316: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1117
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1122) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1118 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAccelerationRS

Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1122) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1119
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property NormalOrientation (p. 1122) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1120 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalAccelerationRS

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1121
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

DirectionalDeformation
Defines a DirectionalDeformation.

Declaration Syntax
public class DirectionalDeformation : DeformationResult

Table 317: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1122 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalDeformation

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1127) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1123
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1127) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1124 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalDeformation

Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property NormalOrientation (p. 1127) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1125
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1126 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocity

Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 318: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1127
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1132) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1128 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocity

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1132) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1129
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property NormalOrientation (p. 1132) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1130 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocity

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1131
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

DirectionalVelocityPSD
Defines a DirectionalVelocityPSD.

Declaration Syntax
public class DirectionalVelocityPSD : DeformationResult

Table 319: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1132 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocityPSD

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1137) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1133
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1137) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1134 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocityPSD

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property NormalOrientation (p. 1137) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1135
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1136 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocityRS

Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1137
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Declaration Syntax
public class DirectionalVelocityRS : DeformationResult

Table 320: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1138 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocityRS

Property DataModelObjectCategory (p. 1142) Gets the current DataModelObject's


category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1142) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1139
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1140 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalVelocityRS

Property NormalOrientation (p. 1142) Gets or sets the NormalOrientation.


Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1141
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1142 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalAcceleration

TotalAcceleration
Defines a TotalAcceleration.

Declaration Syntax
public class TotalAcceleration : DeformationResult

Table 321: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1143
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property DataModelObjectCategory (p. 1147) Gets the current DataModelObject's
category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1147) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1144 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalAcceleration

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1145
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)


Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1146 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalDeformation

(Inherited from DeformationResult (p. 1099).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

TotalDeformation
Defines a TotalDeformation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1147
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Declaration Syntax
public class TotalDeformation : DeformationResult

Table 322: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1148 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalDeformation

Property DataModelObjectCategory (p. 1152) Gets the current DataModelObject's


category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1152) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1149
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1150 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalDeformation

Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1151
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1152 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalVelocity

Declaration Syntax
public class TotalVelocity : DeformationResult

Table 323: Members

Property AccelerationInG (p. 1103) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1099).)


Property AllowPhaseSweep (p. 1103) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1099).)


Property Amplitude (p. 1103) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1099).)


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property CyclicMode (p. 1104) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1099).)


Property CyclicPhase (p. 1104) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1099).)


Property DampedFrequency (p. 1104) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1153
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property DataModelObjectCategory (p. 1157) Gets the current DataModelObject's


category.
Property DeformationType (p. 1104) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1099).)


Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1104) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1099).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property HarmonicIndex (p. 1105) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1099).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1157) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1105) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1099).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1154 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalVelocity

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property LogarithmicDecrement (p. 1105) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1099).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property ModalDampingRatio (p. 1105) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1099).)


Property Mode (p. 1105) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1155
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property PhaseIncrement (p. 1106) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1099).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Probability (p. 1106) Gets the Probability.

(Inherited from DeformationResult (p. 1099).)


Property Reference (p. 1106) Gets the Reference.

(Inherited from DeformationResult (p. 1099).)


Property ReportedFrequency (p. 1106) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1099).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1106) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1099).)


Property ScaleFactorValue (p. 1106) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1099).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Stability (p. 1107) Gets the Stability.

(Inherited from DeformationResult (p. 1099).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1107) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1099).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1156 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorDeformation

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1157
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Declaration Syntax
public class VectorDeformation : Result

Table 324: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1161) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1158 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorDeformation

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1161) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1159
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1160 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorDeformation

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1161
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1162 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 325: Members

DamageResult (p. 1163) Defines a DamageResult.


DamageStatus (p. 1167) Defines a DamageStatus.
EnergyDissipatedPerUnitVolume (p. 1171) Defines a EnergyDissipatedPerUnitVolume.
FiberCompressiveDamageVariable (p. 1175) Defines a
FiberCompressiveDamageVariable.
FiberCompressiveFailureCriterion (p. 1179) Defines a FiberCompressiveFailureCriterion.
FiberTensileDamageVariable (p. 1183) Defines a FiberTensileDamageVariable.
FiberTensileFailureCriterion (p. 1187) Defines a FiberTensileFailureCriterion.
MatrixCompressiveDamageVariable (p. 1190) Defines a
MatrixCompressiveDamageVariable.
MatrixCompressiveFailureCriterion (p. 1194) Defines a
MatrixCompressiveFailureCriterion.
MatrixTensileDamageVariable (p. 1198) Defines a MatrixTensileDamageVariable.
MatrixTensileFailureCriterion (p. 1202) Defines a MatrixTensileFailureCriterion.
MaximumFailureCriteria (p. 1206) Defines a MaximumFailureCriteria.
MullinsDamageVariable (p. 1210) Defines a MullinsDamageVariable.
MullinsMaximumPreviousStrainEnergy (p. 1213) Defines a
MullinsMaximumPreviousStrainEnergy.
ShearDamageVariable (p. 1217) Defines a ShearDamageVariable.

DamageResult
Defines a DamageResult.

Declaration Syntax
public abstract class DamageResult : Result

Table 326: Members

Property Average (p. 918) Gets the Average.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1163
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.
Property DataModelObjectCategory (p. 1167) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1167) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1164 of ANSYS, Inc. and its subsidiaries and affiliates.
DamageResult

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1165
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1166 of ANSYS, Inc. and its subsidiaries and affiliates.
DamageStatus

Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Declaration Syntax
public uint Mode { set;get; }

Surface
Gets the Surface.

Declaration Syntax
public uint Surface { get; }

DamageStatus
Defines a DamageStatus.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1167
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class DamageStatus : DamageResult

Table 327: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1171) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1168 of ANSYS, Inc. and its subsidiaries and affiliates.
DamageStatus

Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1171) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1169
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1170 of ANSYS, Inc. and its subsidiaries and affiliates.
EnergyDissipatedPerUnitVolume

Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

EnergyDissipatedPerUnitVolume
Defines a EnergyDissipatedPerUnitVolume.

Declaration Syntax
public class EnergyDissipatedPerUnitVolume : DamageResult

Table 328: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1171
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1175) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1175) Gets the internal object. For advanced
usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1172 of ANSYS, Inc. and its subsidiaries and affiliates.
EnergyDissipatedPerUnitVolume

Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1173
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1174 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberCompressiveDamageVariable

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Declaration Syntax
public class FiberCompressiveDamageVariable : DamageResult

Table 329: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1175
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1179) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1179) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1176 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberCompressiveDamageVariable

Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1177
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1178 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberCompressiveFailureCriterion

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.

Declaration Syntax
public class FiberCompressiveFailureCriterion : DamageResult

Table 330: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1179
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Coordinate System for a result that is sub


scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1182) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1183) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1180 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberCompressiveFailureCriterion

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1181
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property SolutionCombinationDriver (p. 924) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1182 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberTensileDamageVariable

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

FiberTensileDamageVariable
Defines a FiberTensileDamageVariable.

Declaration Syntax
public class FiberTensileDamageVariable : DamageResult

Table 331: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1186) Gets the current DataModelObject's
category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1183
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1186) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1184 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberTensileDamageVariable

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1185
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1186 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberTensileFailureCriterion

FiberTensileFailureCriterion
Defines a FiberTensileFailureCriterion.

Declaration Syntax
public class FiberTensileFailureCriterion : DamageResult

Table 332: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1190) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1187
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1190) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1188 of ANSYS, Inc. and its subsidiaries and affiliates.
FiberTensileFailureCriterion

Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1189
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1190 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixCompressiveDamageVariable

Declaration Syntax
public class MatrixCompressiveDamageVariable : DamageResult

Table 333: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1194) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1191
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1194) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1192 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixCompressiveDamageVariable

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1193
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Declaration Syntax
public class MatrixCompressiveFailureCriterion : DamageResult

Table 334: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1194 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixCompressiveFailureCriterion

Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1198) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1198) Gets the internal object. For advanced
usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1195
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1196 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixCompressiveFailureCriterion

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1197
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Declaration Syntax
public class MatrixTensileDamageVariable : DamageResult

Table 335: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1198 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixTensileDamageVariable

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1202) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1202) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1199
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1200 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixTensileDamageVariable

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1201
Ansys.ACT.Automation.Mechanical.Results.DamageResults 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; }

MatrixTensileFailureCriterion
Defines a MatrixTensileFailureCriterion.

Declaration Syntax
public class MatrixTensileFailureCriterion : DamageResult

Table 336: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1202 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixTensileFailureCriterion

Coordinate System for a result that is sub


scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1205) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1206) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1203
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1204 of ANSYS, Inc. and its subsidiaries and affiliates.
MatrixTensileFailureCriterion

Property SolutionCombinationDriver (p. 924) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1205
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MaximumFailureCriteria
Defines a MaximumFailureCriteria.

Declaration Syntax
public class MaximumFailureCriteria : DamageResult

Table 337: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1209) Gets the current DataModelObject's
category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1206 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumFailureCriteria

Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1209) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1207
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1208 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumFailureCriteria

Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1209
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

MullinsDamageVariable
Defines a MullinsDamageVariable.

Declaration Syntax
public class MullinsDamageVariable : DamageResult

Table 338: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1213) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1210 of ANSYS, Inc. and its subsidiaries and affiliates.
MullinsDamageVariable

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1213) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1211
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1212 of ANSYS, Inc. and its subsidiaries and affiliates.
MullinsMaximumPreviousStrainEnergy

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

MullinsMaximumPreviousStrainEnergy
Defines a MullinsMaximumPreviousStrainEnergy.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1213
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class MullinsMaximumPreviousStrainEnergy : DamageResult

Table 339: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1217) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1214 of ANSYS, Inc. and its subsidiaries and affiliates.
MullinsMaximumPreviousStrainEnergy

Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1217) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1215
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1216 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearDamageVariable

Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

ShearDamageVariable
Defines a ShearDamageVariable.

Declaration Syntax
public class ShearDamageVariable : DamageResult

Table 340: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1217
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DamageResultType (p. 1167) Gets the DamageResultType.

(Inherited from DamageResult (p. 1163).)


Property DataModelObjectCategory (p. 1221) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1221) Gets the internal object. For advanced
usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1218 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearDamageVariable

Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1219
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1167) Gets or sets the Mode.

(Inherited from DamageResult (p. 1163).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1167) Gets the Surface.

(Inherited from DamageResult (p. 1163).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1220 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearDamageVariable

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1221
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1222 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults

Table 341: Members

CoordinateSystemsResult (p. 1223) Defines a


CoordinateSystemsResult.
ElementalEulerXYAngle (p. 1229) Defines a
ElementalEulerXYAngle.
ElementalEulerXZAngle (p. 1233) Defines a
ElementalEulerXZAngle.
ElementalEulerYZAngle (p. 1238) Defines a
ElementalEulerYZAngle.
ElementalTriads (p. 1242) Defines a ElementalTriads.
NodalEulerXYAngle (p. 1246) Defines a NodalEulerXYAngle.
NodalEulerXZAngle (p. 1251) Defines a NodalEulerXZAngle.
NodalEulerYZAngle (p. 1255) Defines a NodalEulerYZAngle.
NodalTriads (p. 1260) Defines a NodalTriads.

CoordinateSystemsResult
Defines a CoordinateSystemsResult.

Declaration Syntax
public abstract class CoordinateSystemsResult : Result

Table 342: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1223
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1227) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1227) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1224 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystemsResult

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1225
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.
Property Position (p. 1228) Gets or sets the Position.
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1226 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystemsResult

Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LoadMultiplier
Gets the LoadMultiplier.

Declaration Syntax
public double LoadMultiplier { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1227
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Mode
Gets or sets the Mode.

Declaration Syntax
public uint Mode { 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; }

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; }

SubScopeBy
Gets or sets the SubScopeBy.

Declaration Syntax
public SubScopingDefineByType SubScopeBy { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1228 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerXYAngle

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

ElementalEulerXYAngle
Defines a ElementalEulerXYAngle.

Declaration Syntax
public class ElementalEulerXYAngle : CoordinateSystemsResult

Table 343: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1229
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property DataModelObjectCategory (p. 1233) Gets the current DataModelObject's


category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1233) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1230 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerXYAngle

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1231
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1232 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerXZAngle

Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

ElementalEulerXZAngle
Defines a ElementalEulerXZAngle.

Declaration Syntax
public class ElementalEulerXZAngle : CoordinateSystemsResult

Table 344: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1233
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1237) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1237) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1234 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerXZAngle

Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1235
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1236 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerXZAngle

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1237
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

ElementalEulerYZAngle
Defines a ElementalEulerYZAngle.

Declaration Syntax
public class ElementalEulerYZAngle : CoordinateSystemsResult

Table 345: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1242) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1238 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerYZAngle

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1242) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1239
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1240 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalEulerYZAngle

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1241
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

ElementalTriads
Defines a ElementalTriads.

Declaration Syntax
public class ElementalTriads : CoordinateSystemsResult

Table 346: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1242 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalTriads

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1246) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1246) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1243
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1244 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalTriads

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1245
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

NodalEulerXYAngle
Defines a NodalEulerXYAngle.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1246 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerXYAngle

Declaration Syntax
public class NodalEulerXYAngle : CoordinateSystemsResult

Table 347: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1251) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1247
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1251) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1248 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerXYAngle

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1249
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1250 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerXZAngle

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; }

NodalEulerXZAngle
Defines a NodalEulerXZAngle.

Declaration Syntax
public class NodalEulerXZAngle : CoordinateSystemsResult

Table 348: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1251
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1255) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1255) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1252 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerXZAngle

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1253
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1254 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerYZAngle

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

NodalEulerYZAngle
Defines a NodalEulerYZAngle.

Declaration Syntax
public class NodalEulerYZAngle : CoordinateSystemsResult

Table 349: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1255
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1259) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1256 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerYZAngle

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1260) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1257
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1258 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalEulerYZAngle

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1259
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NodalTriads
Defines a NodalTriads.

Declaration Syntax
public class NodalTriads : CoordinateSystemsResult

Table 350: Members

Property Amplitude (p. 1227) Gets or sets the Amplitude.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1260 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalTriads

Property DataModelObjectCategory (p. 1264) Gets the current DataModelObject's


category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1227) Gets or sets the Frequency.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1264) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadMultiplier (p. 1227) Gets the LoadMultiplier.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1261
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Mode (p. 1228) Gets or sets the Mode.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Ply (p. 1228) Gets or sets the Ply selection.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Position (p. 1228) Gets or sets the Position.

(Inherited from
CoordinateSystemsResult (p. 1223).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1262 of ANSYS, Inc. and its subsidiaries and affiliates.
NodalTriads

Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScaleFactor (p. 1228) Gets or sets the ScaleFactor.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScaleFactorValue (p. 1228) Gets or sets the ScaleFactorValue.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property SubScopeBy (p. 1228) Gets or sets the SubScopeBy.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property SweepingPhase (p. 1229) Gets or sets the SweepingPhase.

(Inherited from
CoordinateSystemsResult (p. 1223).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1263
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace

Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1264 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.ThermalResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.ThermalResults

Table 351: Members

DirectionalHeatFlux (p. 1265) Defines a DirectionalHeatFlux.


DirectionalThermalHeatFlux (p. 1269) Defines a
DirectionalThermalHeatFlux.
FluidFlowRate (p. 1273) Defines a FluidFlowRate.
FluidHeatConductionRate (p. 1277) Defines a
FluidHeatConductionRate.
FluidHeatTransportRate (p. 1281) Defines a
FluidHeatTransportRate.
TemperatureResult (p. 1285) Defines a TemperatureResult.
ThermalError (p. 1289) Defines a ThermalError.
ThermalResult (p. 1293) Defines a ThermalResult.
TotalHeatFlux (p. 1297) Defines a TotalHeatFlux.
VectorHeatFlux (p. 1301) Defines a VectorHeatFlux.

DirectionalHeatFlux
Defines a DirectionalHeatFlux.

Declaration Syntax
public class DirectionalHeatFlux : ThermalResult

Table 352: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1265
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1269) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1269) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1266 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalHeatFlux

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1267
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1268 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalHeatFlux

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

DirectionalThermalHeatFlux
Defines a DirectionalThermalHeatFlux.

Declaration Syntax
public class DirectionalThermalHeatFlux : ThermalResult

Table 353: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1269
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1273) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1273) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1270 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalHeatFlux

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1271
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1272 of ANSYS, Inc. and its subsidiaries and affiliates.
FluidFlowRate

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

FluidFlowRate
Defines a FluidFlowRate.

Declaration Syntax
public class FluidFlowRate : ThermalResult

Table 354: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1273
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1277) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1277) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1274 of ANSYS, Inc. and its subsidiaries and affiliates.
FluidFlowRate

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1275
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1276 of ANSYS, Inc. and its subsidiaries and affiliates.
FluidHeatConductionRate

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; }

FluidHeatConductionRate
Defines a FluidHeatConductionRate.

Declaration Syntax
public class FluidHeatConductionRate : ThermalResult

Table 355: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1277
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1281) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1281) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1278 of ANSYS, Inc. and its subsidiaries and affiliates.
FluidHeatConductionRate

Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1279
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1280 of ANSYS, Inc. and its subsidiaries and affiliates.
FluidHeatTransportRate

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; }

FluidHeatTransportRate
Defines a FluidHeatTransportRate.

Declaration Syntax
public class FluidHeatTransportRate : ThermalResult

Table 356: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1281
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1285) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1285) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1282 of ANSYS, Inc. and its subsidiaries and affiliates.
FluidHeatTransportRate

Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1283
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1284 of ANSYS, Inc. and its subsidiaries and affiliates.
TemperatureResult

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; }

TemperatureResult
Defines a TemperatureResult.

Declaration Syntax
public class TemperatureResult : ThermalResult

Table 357: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1285
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1289) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1289) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1286 of ANSYS, Inc. and its subsidiaries and affiliates.
TemperatureResult

Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1287
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1288 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalError

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; }

ThermalError
Defines a ThermalError.

Declaration Syntax
public class ThermalError : ThermalResult

Table 358: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1289
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1293) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1293) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1290 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalError

Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1291
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1292 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalResult

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; }

ThermalResult
Defines a ThermalResult.

Declaration Syntax
public abstract class ThermalResult : Result

Table 359: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1293
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Accepts/Returns None for Fiber


Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1296) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1297) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1294 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalResult

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1295
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Property SolutionCombinationDriver (p. 924) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Declaration Syntax
public bool AverageAcrossBodies { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1296 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalHeatFlux

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; }

Position
Gets or sets the Position.

Declaration Syntax
public ShellFaceType Position { set;get; }

ThermalResultType
Gets or sets the ThermalResultType.

Declaration Syntax
public TotalOrDirectional ThermalResultType { set;get; }

TotalHeatFlux
Defines a TotalHeatFlux.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1297
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Declaration Syntax
public class TotalHeatFlux : ThermalResult

Table 360: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1296) Gets or sets the AverageAcrossBodies.

(Inherited from ThermalResult (p. 1293).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1301) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1298 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalHeatFlux

Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1301) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Layer (p. 1297) Gets or sets the Layer.

(Inherited from ThermalResult (p. 1293).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1299
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1297) Gets or sets the NormalOrientation.

(Inherited from ThermalResult (p. 1293).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1297) Gets or sets the Position.

(Inherited from ThermalResult (p. 1293).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1300 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorHeatFlux

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThermalResultType (p. 1297) Gets or sets the ThermalResultType.

(Inherited from ThermalResult (p. 1293).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

VectorHeatFlux
Defines a VectorHeatFlux.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1301
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

Declaration Syntax
public class VectorHeatFlux : Result

Table 361: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1305) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1302 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorHeatFlux

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1305) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1303
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1304 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorHeatFlux

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1305
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1306 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.StressToolResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.StressToolResults

Table 362: Members

StressRatio (p. 1307) Defines a StressRatio.


StressSafetyFactor (p. 1311) Defines a
StressSafetyFactor.
StressSafetyMargin (p. 1314) Defines a
StressSafetyMargin.
StressTool (p. 1318) Defines a StressTool.
StressToolResult (p. 1323) Defines a
StressToolResult.

StressRatio
Defines a StressRatio.

Declaration Syntax
public class StressRatio : StressToolResult

Table 363: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1327) Gets or sets the AverageAcrossBodies.

(Inherited from StressToolResult (p. 1323).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1307
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1310) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1311) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1308 of ANSYS, Inc. and its subsidiaries and affiliates.
StressRatio

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1309
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1310 of ANSYS, Inc. and its subsidiaries and affiliates.
StressSafetyFactor

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

StressSafetyFactor
Defines a StressSafetyFactor.

Declaration Syntax
public class StressSafetyFactor : StressToolResult

Table 364: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1327) Gets or sets the AverageAcrossBodies.

(Inherited from StressToolResult (p. 1323).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1314) Gets the current DataModelObject's
category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1311
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1314) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1312 of ANSYS, Inc. and its subsidiaries and affiliates.
StressSafetyFactor

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1313
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

StressSafetyMargin
Defines a StressSafetyMargin.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1314 of ANSYS, Inc. and its subsidiaries and affiliates.
StressSafetyMargin

Declaration Syntax
public class StressSafetyMargin : StressToolResult

Table 365: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1327) Gets or sets the AverageAcrossBodies.

(Inherited from StressToolResult (p. 1323).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1318) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1315
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1318) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1316 of ANSYS, Inc. and its subsidiaries and affiliates.
StressSafetyMargin

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1317
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

StressTool
Defines a StressTool.

Declaration Syntax
public class StressTool : DataModelObject, IFolderDataModelObject

Table 366: Members

Property Children (p. 1319) Gets the list of children.


Property Comments (p. 1319) Gets the list of associated comments.
Property CompressiveLimit (p. 1319) Gets or sets the CompressiveLimit.
Property CompressiveLimitType (p. 1320) Gets or sets the CompressiveLimitType.
Property DataModelObjectCategory (p. 1320) Gets the current DataModelObject's category.
Property Figures (p. 1320) Gets the list of associated figures.
Property Images (p. 1320) Gets the list of associated images.
Property InternalObject (p. 1320) Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1318 of ANSYS, Inc. and its subsidiaries and affiliates.
StressTool

Property LimitFactor (p. 1320) Gets or sets the LimitFactor.


Property StressLimit (p. 1321) Gets or sets the StressLimit.
Property StressLimitType (p. 1321) Gets or sets the StressLimitType.
Property TensileLimit (p. 1321) Gets or sets the TensileLimit.
Property TensileLimitType (p. 1321) Gets or sets the TensileLimitType.
Property Theory (p. 1321) Gets or sets the Theory.
Method AddComment() (p. 1321) Creates a new child Comment.
Method AddFigure() (p. 1322) Creates a new child Figure.
Method AddImage(string) (p. 1322) Creates a new child Image. If a 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 AddSafetyFactor() (p. 1322) Creates a new StressSafetyFactor
Method AddSafetyMargin() (p. 1322) Creates a new StressSafetyMargin
Method AddStressRatio() (p. 1322) Creates a new StressRatio
Method Delete() (p. 1322) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1323)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<DataModelObject>) (p. 1323)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CompressiveLimit
Gets or sets the CompressiveLimit.

Declaration Syntax
public Quantity CompressiveLimit { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1319
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

CompressiveLimitType
Gets or sets the CompressiveLimitType.

Declaration Syntax
public SafetyLimitType CompressiveLimitType { 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 IDSStressSafetyToolAuto InternalObject { get; }

LimitFactor
Gets or sets the LimitFactor.

Declaration Syntax
public double LimitFactor { set;get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1320 of ANSYS, Inc. and its subsidiaries and affiliates.
StressTool

StressLimit
Gets or sets the StressLimit.

Declaration Syntax
public Quantity StressLimit { set;get; }

StressLimitType
Gets or sets the StressLimitType.

Declaration Syntax
public SafetyLimitType StressLimitType { set;get; }

TensileLimit
Gets or sets the TensileLimit.

Declaration Syntax
public Quantity TensileLimit { set;get; }

TensileLimitType
Gets or sets the TensileLimitType.

Declaration Syntax
public SafetyLimitType TensileLimitType { set;get; }

Theory
Gets or sets the Theory.

Declaration Syntax
public SafetyTheoryType Theory { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1321
Ansys.ACT.Automation.Mechanical.Results.StressToolResults 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.

AddSafetyFactor()
Creates a new StressSafetyFactor

Declaration Syntax
public virtual StressSafetyFactor AddSafetyFactor()

AddSafetyMargin()
Creates a new StressSafetyMargin

Declaration Syntax
public virtual StressSafetyMargin AddSafetyMargin()

AddStressRatio()
Creates a new StressRatio

Declaration Syntax
public virtual StressRatio AddStressRatio()

Delete()
Run the Delete action.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1322 of ANSYS, Inc. and its subsidiaries and affiliates.
StressToolResult

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<DataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<DataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<DataModelObject> children)

Parameters
category(DataModelObjectCategory)
The category of the data model object to retrieve.

recurses(bool)
Whether to retrieve grandchildren recursively.

children(IList<DataModelObject>)
Input list that will be populated through the whole process. (If not specified a new list will be created.)

StressToolResult
Defines a StressToolResult.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1323
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Declaration Syntax
public abstract class StressToolResult : Result

Table 367: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1327) Gets or sets the AverageAcrossBodies.
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1327) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1324 of ANSYS, Inc. and its subsidiaries and affiliates.
StressToolResult

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1327) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1325
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace

Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1326 of ANSYS, Inc. and its subsidiaries and affiliates.
StressToolResult

Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Declaration Syntax
public bool AverageAcrossBodies { 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 IDSResultAuto InternalObject { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1327
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1328 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults

Table 368: Members

LinearizedEquivalentStress (p. 1329) Defines a LinearizedEquivalentStress.


LinearizedMaximumPrincipalStress (p. 1335) Defines a
LinearizedMaximumPrincipalStress.
LinearizedMaximumShearStress (p. 1340) Defines a
LinearizedMaximumShearStress.
LinearizedMiddlePrincipalStress (p. 1346) Defines a
LinearizedMiddlePrincipalStress.
LinearizedMinimumPrincipalStress (p. 1352) Defines a
LinearizedMinimumPrincipalStress.
LinearizedNormalStress (p. 1357) Defines a LinearizedNormalStress.
LinearizedShearStress (p. 1363) Defines a LinearizedShearStress.
LinearizedStressIntensity (p. 1369) Defines a LinearizedStressIntensity.
LinearizedStressResult (p. 1374) Defines a LinearizedStressResult.

LinearizedEquivalentStress
Defines a LinearizedEquivalentStress.

Declaration Syntax
public class LinearizedEquivalentStress : LinearizedStressResult

Table 369: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1329
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1334) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1330 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedEquivalentStress

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1335) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1331
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1332 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedEquivalentStress

Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1333
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1334 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMaximumPrincipalStress

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LinearizedMaximumPrincipalStress
Defines a LinearizedMaximumPrincipalStress.

Declaration Syntax
public class LinearizedMaximumPrincipalStress : LinearizedStressResult

Table 370: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1335
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1340) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1340) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1336 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMaximumPrincipalStress

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1337
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1338 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMaximumPrincipalStress

Property SolutionCombinationDriver (p. 924) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1339
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

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; }

LinearizedMaximumShearStress
Defines a LinearizedMaximumShearStress.

Declaration Syntax
public class LinearizedMaximumShearStress : LinearizedStressResult

Table 371: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1340 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMaximumShearStress

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1346) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1341
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1346) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1342 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMaximumShearStress

Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1343
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property ShearOrientation (p. 1346) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1344 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMaximumShearStress

Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1345
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)

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; }

LinearizedMiddlePrincipalStress
Defines a LinearizedMiddlePrincipalStress.

Declaration Syntax
public class LinearizedMiddlePrincipalStress : LinearizedStressResult

Table 372: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1346 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMiddlePrincipalStress

Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1351) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1347
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1351) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1348 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMiddlePrincipalStress

Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1349
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1350 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMiddlePrincipalStress

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1351
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LinearizedMinimumPrincipalStress
Defines a LinearizedMinimumPrincipalStress.

Declaration Syntax
public class LinearizedMinimumPrincipalStress : LinearizedStressResult

Table 373: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1352 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMinimumPrincipalStress

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1357) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1357) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1353
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1354 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedMinimumPrincipalStress

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1355
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1356 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedNormalStress

Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

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; }

LinearizedNormalStress
Defines a LinearizedNormalStress.

Declaration Syntax
public class LinearizedNormalStress : LinearizedStressResult

Table 374: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1357
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property AverageRadiusOfCurvature (p. 1378) Gets or sets the


AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1363) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1358 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedNormalStress

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1363) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1359
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1360 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedNormalStress

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1361
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1362 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedShearStress

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; }

LinearizedShearStress
Defines a LinearizedShearStress.

Declaration Syntax
public class LinearizedShearStress : LinearizedStressResult

Table 375: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1363
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1368) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1368) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1364 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedShearStress

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1365
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1366 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedShearStress

Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property ShearOrientation (p. 1368) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1367
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

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.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1368 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressIntensity

Declaration Syntax
public ShearOrientationType ShearOrientation { set;get; }

LinearizedStressIntensity
Defines a LinearizedStressIntensity.

Declaration Syntax
public class LinearizedStressIntensity : LinearizedStressResult

Table 376: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingInside (p. 1378) Gets the BendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property BendingOutside (p. 1379) Gets the BendingOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1369
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1374) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from
LinearizedStressResult (p. 1374).)
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1374) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1370 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressIntensity

(Inherited from
LinearizedStressResult (p. 1374).)
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1371
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

(Inherited from
LinearizedStressResult (p. 1374).)
Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakCenter (p. 1380) Gets the PeakCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakInside (p. 1381) Gets the PeakInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PeakOutside (p. 1381) Gets the PeakOutside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.

(Inherited from
LinearizedStressResult (p. 1374).)
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1372 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressIntensity

Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.

(Inherited from
LinearizedStressResult (p. 1374).)
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.

(Inherited from
LinearizedStressResult (p. 1374).)
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1373
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalInside (p. 1382) Gets the TotalInside.

(Inherited from
LinearizedStressResult (p. 1374).)
Property TotalOutside (p. 1382) Gets the TotalOutside.

(Inherited from
LinearizedStressResult (p. 1374).)

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; }

LinearizedStressResult
Defines a LinearizedStressResult.

Declaration Syntax
public abstract class LinearizedStressResult : Result

Table 377: Members

Property Amplitude (p. 1378) Gets or sets the Amplitude.


Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageRadiusOfCurvature (p. 1378) Gets or sets the
AverageRadiusOfCurvature.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1374 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressResult

Property BendingInside (p. 1378) Gets the BendingInside.


Property BendingOutside (p. 1379) Gets the BendingOutside.
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1379) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property Frequency (p. 1379) Gets or sets the Frequency.
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1379) Gets the internal object. For advanced
usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1375
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property Linearized2DBehavior (p. 1379) Gets or sets the Linearized2DBehavior.
Property LoadMultiplier (p. 1379) Gets the LoadMultiplier.
Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Membrane (p. 1380) Gets the Membrane.
Property MembraneBendingCenter (p. 1380) Gets the MembraneBendingCenter.
Property MembraneBendingInside (p. 1380) Gets the MembraneBendingInside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1376 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressResult

Property MembraneBendingOutside (p. 1380) Gets the MembraneBendingOutside.


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1380) Gets or sets the NormalOrientation.
Property PeakCenter (p. 1380) Gets the PeakCenter.
Property PeakInside (p. 1381) Gets the PeakInside.
Property PeakOutside (p. 1381) Gets the PeakOutside.
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property Position (p. 1381) Gets or sets the Position.
Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property StressStrainType (p. 1381) Gets or sets the StressStrainType.
Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Subtype (p. 1381) Gets or sets the Subtype.
Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property Surface (p. 1381) Gets the Surface.
Property SweepingPhase (p. 1382) Gets or sets the SweepingPhase.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1377
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property ThroughThicknessBendingStress (p. 1382) Gets or sets the
ThroughThicknessBendingStress.
Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property TotalCenter (p. 1382) Gets the TotalCenter.
Property TotalInside (p. 1382) Gets the TotalInside.
Property TotalOutside (p. 1382) Gets the TotalOutside.

Amplitude
Gets or sets the Amplitude.

Declaration Syntax
public bool Amplitude { set;get; }

AverageRadiusOfCurvature
Gets or sets the AverageRadiusOfCurvature.

Declaration Syntax
public Quantity AverageRadiusOfCurvature { set;get; }

BendingInside
Gets the BendingInside.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1378 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressResult

Declaration Syntax
public Quantity BendingInside { get; }

BendingOutside
Gets the BendingOutside.

Declaration Syntax
public Quantity BendingOutside { 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.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Linearized2DBehavior
Gets or sets the Linearized2DBehavior.

Declaration Syntax
public Linearized2DBehavior Linearized2DBehavior { set;get; }

LoadMultiplier
Gets the LoadMultiplier.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1379
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Declaration Syntax
public double LoadMultiplier { get; }

Membrane
Gets the Membrane.

Declaration Syntax
public Quantity Membrane { get; }

MembraneBendingCenter
Gets the MembraneBendingCenter.

Declaration Syntax
public Quantity MembraneBendingCenter { get; }

MembraneBendingInside
Gets the MembraneBendingInside.

Declaration Syntax
public Quantity MembraneBendingInside { get; }

MembraneBendingOutside
Gets the MembraneBendingOutside.

Declaration Syntax
public Quantity MembraneBendingOutside { get; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

PeakCenter
Gets the PeakCenter.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1380 of ANSYS, Inc. and its subsidiaries and affiliates.
LinearizedStressResult

Declaration Syntax
public Quantity PeakCenter { get; }

PeakInside
Gets the PeakInside.

Declaration Syntax
public Quantity PeakInside { get; }

PeakOutside
Gets the PeakOutside.

Declaration Syntax
public Quantity PeakOutside { get; }

Position
Gets or sets the Position.

Declaration Syntax
public ShellFaceType Position { set;get; }

StressStrainType
Gets or sets the StressStrainType.

Declaration Syntax
public StressStrainType StressStrainType { set;get; }

Subtype
Gets or sets the Subtype.

Declaration Syntax
public LinearizedSubtype Subtype { set;get; }

Surface
Gets the Surface.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1381
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace

Declaration Syntax
public uint Surface { get; }

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

ThroughThicknessBendingStress
Gets or sets the ThroughThicknessBendingStress.

Declaration Syntax
public ThroughThicknessBendingStress ThroughThicknessBendingStress { set;get; }

TotalCenter
Gets the TotalCenter.

Declaration Syntax
public Quantity TotalCenter { get; }

TotalInside
Gets the TotalInside.

Declaration Syntax
public Quantity TotalInside { get; }

TotalOutside
Gets the TotalOutside.

Declaration Syntax
public Quantity TotalOutside { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1382 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.GasketResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.GasketResults

Table 378: Members

GasketResult (p. 1383) Defines a GasketResult.


NormalGasketPressure (p. 1387) Defines a
NormalGasketPressure.
NormalGasketTotalClosure (p. 1391) Defines a
NormalGasketTotalClosure.
ShearGasketPressure (p. 1394) Defines a ShearGasketPressure.
ShearGasketTotalClosure (p. 1398) Defines a
ShearGasketTotalClosure.

GasketResult
Defines a GasketResult.

Declaration Syntax
public abstract class GasketResult : Result

Table 379: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1383
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1386) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GasketResultType (p. 1387) Gets or sets the GasketResultType.
Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1387) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1384 of ANSYS, Inc. and its subsidiaries and affiliates.
GasketResult

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1385
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1386 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalGasketPressure

GasketResultType
Gets or sets the GasketResultType.

Declaration Syntax
public GasketResultType GasketResultType { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalGasketPressure
Defines a NormalGasketPressure.

Declaration Syntax
public class NormalGasketPressure : GasketResult

Table 380: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1387
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

Coordinate System for a result that is sub


scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1390) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GasketResultType (p. 1387) Gets or sets the GasketResultType.

(Inherited from GasketResult (p. 1383).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1390) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1388 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalGasketPressure

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1389
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1390 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalGasketTotalClosure

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalGasketTotalClosure
Defines a NormalGasketTotalClosure.

Declaration Syntax
public class NormalGasketTotalClosure : GasketResult

Table 381: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1394) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1391
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

(Inherited from Result (p. 916).)


Property GasketResultType (p. 1387) Gets or sets the GasketResultType.

(Inherited from GasketResult (p. 1383).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1394) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1392 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalGasketTotalClosure

Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1393
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

ShearGasketPressure
Defines a ShearGasketPressure.

Declaration Syntax
public class ShearGasketPressure : GasketResult

Table 382: Members

Property Average (p. 918) Gets the Average.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1394 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearGasketPressure

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1398) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GasketResultType (p. 1387) Gets or sets the GasketResultType.

(Inherited from GasketResult (p. 1383).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1395
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

Property InternalObject (p. 1398) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1396 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearGasketPressure

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property ShearOrientation (p. 1398) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1397
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

ShearGasketTotalClosure
Defines a ShearGasketTotalClosure.

Declaration Syntax
public class ShearGasketTotalClosure : GasketResult

Table 383: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1398 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearGasketTotalClosure

Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1402) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GasketResultType (p. 1387) Gets or sets the GasketResultType.

(Inherited from GasketResult (p. 1383).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1402) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1399
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1400 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearGasketTotalClosure

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property ShearOrientation (p. 1402) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1401
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace

(Inherited from Result (p. 916).)

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; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1402 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.EnergyResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.EnergyResults

Table 384: Members

ElementalStrainEnergy (p. 1403) Defines a


ElementalStrainEnergy.
EnergyResult (p. 1407) Defines a EnergyResult.
StabilizationEnergy (p. 1410) Defines a
StabilizationEnergy.
StructuralStrainEnergy (p. 1414) Defines a
StructuralStrainEnergy.
ThermalStrainEnergy (p. 1418) Defines a
ThermalStrainEnergy.

ElementalStrainEnergy
Defines a ElementalStrainEnergy.

Declaration Syntax
public class ElementalStrainEnergy : EnergyResult

Table 385: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1403
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1406) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1407) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1404 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementalStrainEnergy

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1405
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1406 of ANSYS, Inc. and its subsidiaries and affiliates.
EnergyResult

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EnergyResult
Defines a EnergyResult.

Declaration Syntax
public abstract class EnergyResult : Result

Table 386: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1410) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1407
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1410) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1408 of ANSYS, Inc. and its subsidiaries and affiliates.
EnergyResult

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1409
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

StabilizationEnergy
Defines a StabilizationEnergy.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1410 of ANSYS, Inc. and its subsidiaries and affiliates.
StabilizationEnergy

Declaration Syntax
public class StabilizationEnergy : EnergyResult

Table 387: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1414) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1411
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1414) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1412 of ANSYS, Inc. and its subsidiaries and affiliates.
StabilizationEnergy

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1413
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

StructuralStrainEnergy
Defines a StructuralStrainEnergy.

Declaration Syntax
public class StructuralStrainEnergy : EnergyResult

Table 388: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1414 of ANSYS, Inc. and its subsidiaries and affiliates.
StructuralStrainEnergy

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1417) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1418) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1415
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1416 of ANSYS, Inc. and its subsidiaries and affiliates.
StructuralStrainEnergy

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1417
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

ThermalStrainEnergy
Defines a ThermalStrainEnergy.

Declaration Syntax
public class ThermalStrainEnergy : EnergyResult

Table 389: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1421) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1418 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalStrainEnergy

Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1421) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1419
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1420 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalStrainEnergy

Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1421
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1422 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults

Table 390: Members

CurrentDensity (p. 1423) Defines a CurrentDensity.


DirectionalMagneticFieldIntensity (p. 1427) Defines a
DirectionalMagneticFieldIntensity.
DirectionalMagneticFluxDensity (p. 1431) Defines a
DirectionalMagneticFluxDensity.
ElectricPotential (p. 1435) Defines a ElectricPotential.
ElectromagneticResult (p. 1439) Defines a ElectromagneticResult.
FluxLinkage (p. 1443) Defines a FluxLinkage.
Inductance (p. 1444) Defines a Inductance.
MagneticDirectionalForces (p. 1445) Defines a MagneticDirectionalForces.
MagneticError (p. 1449) Defines a MagneticError.
MagneticTotalForces (p. 1453) Defines a MagneticTotalForces.
TotalMagneticFieldIntensity (p. 1457) Defines a TotalMagneticFieldIntensity.
TotalMagneticFluxDensity (p. 1460) Defines a TotalMagneticFluxDensity.

CurrentDensity
Defines a CurrentDensity.

Declaration Syntax
public class CurrentDensity : ElectromagneticResult

Table 391: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1423
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1427) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1424 of ANSYS, Inc. and its subsidiaries and affiliates.
CurrentDensity

Property InternalObject (p. 1427) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1425
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1426 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalMagneticFieldIntensity

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

DirectionalMagneticFieldIntensity
Defines a DirectionalMagneticFieldIntensity.

Declaration Syntax
public class DirectionalMagneticFieldIntensity : ElectromagneticResult

Table 392: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1427
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1431) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1431) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1428 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalMagneticFieldIntensity

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1431) Gets or sets the NormalOrientation.
Property PlotData (p. 923) Gets the result table.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1429
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1430 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalMagneticFluxDensity

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; }

DirectionalMagneticFluxDensity
Defines a DirectionalMagneticFluxDensity.

Declaration Syntax
public class DirectionalMagneticFluxDensity : ElectromagneticResult

Table 393: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1431
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1435) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1435) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1432 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalMagneticFluxDensity

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1435) Gets or sets the NormalOrientation.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1433
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1434 of ANSYS, Inc. and its subsidiaries and affiliates.
ElectricPotential

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; }

ElectricPotential
Defines a ElectricPotential.

Declaration Syntax
public class ElectricPotential : ElectromagneticResult

Table 394: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1435
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1439) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1439) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1436 of ANSYS, Inc. and its subsidiaries and affiliates.
ElectricPotential

Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1437
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1438 of ANSYS, Inc. and its subsidiaries and affiliates.
ElectromagneticResult

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; }

ElectromagneticResult
Defines a ElectromagneticResult.

Declaration Syntax
public abstract class ElectromagneticResult : Result

Table 395: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1439
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Accepts/Returns None for Fiber


Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1442) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1443) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1440 of ANSYS, Inc. and its subsidiaries and affiliates.
ElectromagneticResult

Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1441
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Declaration Syntax
public bool AverageAcrossBodies { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1442 of ANSYS, Inc. and its subsidiaries and affiliates.
FluxLinkage

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElectromagneticResultType
Gets or sets the ElectromagneticResultType.

Declaration Syntax
public TotalOrDirectional ElectromagneticResultType { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

FluxLinkage
Defines a FluxLinkage.

Declaration Syntax
public class FluxLinkage : ResultTable

Table 396: Members

Property Children (p. 940) Gets the list of children.

(Inherited from ResultTable (p. 939).)


Property Comments (p. 940) Gets the list of associated comments.

(Inherited from ResultTable (p. 939).)


Property DataModelObjectCategory (p. 1444)Gets the current DataModelObject's
category.
Property Images (p. 941) Gets the list of associated images.

(Inherited from ResultTable (p. 939).)


Property InternalObject (p. 1444) Gets the internal object. For advanced usage
only.
Property Multiplier (p. 941) Gets or sets the Multiplier.

(Inherited from ResultTable (p. 939).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1443
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults 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 IDSResultTableAuto InternalObject { get; }

Inductance
Defines a Inductance.

Declaration Syntax
public class Inductance : ResultTable

Table 397: Members

Property Children (p. 940) Gets the list of children.

(Inherited from ResultTable (p. 939).)


Property Comments (p. 940) Gets the list of associated comments.

(Inherited from ResultTable (p. 939).)


Property DataModelObjectCategory (p. 1444)Gets the current DataModelObject's
category.
Property Images (p. 941) Gets the list of associated images.

(Inherited from ResultTable (p. 939).)


Property InternalObject (p. 1445) Gets the internal object. For advanced usage
only.
Property Multiplier (p. 941) Gets or sets the Multiplier.

(Inherited from ResultTable (p. 939).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1444 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticDirectionalForces

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultTableAuto InternalObject { get; }

MagneticDirectionalForces
Defines a MagneticDirectionalForces.

Declaration Syntax
public class MagneticDirectionalForces : ElectromagneticResult

Table 398: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1445
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Coordinate System for a result that is sub


scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1448) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1448) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1446 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticDirectionalForces

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property NormalOrientation (p. 1449) Gets or sets the NormalOrientation.
Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1447
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property SolutionCombinationDriver (p. 924) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1448 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticError

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

MagneticError
Defines a MagneticError.

Declaration Syntax
public class MagneticError : ElectromagneticResult

Table 399: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1449
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Coordinate System for a result that is sub


scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1452) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1452) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1450 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticError

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1451
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property SolutionCombinationDriver (p. 924) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1452 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticTotalForces

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MagneticTotalForces
Defines a MagneticTotalForces.

Declaration Syntax
public class MagneticTotalForces : ElectromagneticResult

Table 400: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1456) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1453
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1456) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1454 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticTotalForces

Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1455
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Total (p. 1456) Gets the Total.

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; }

Total
Gets the Total.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1456 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalMagneticFieldIntensity

Declaration Syntax
public Quantity Total { get; }

TotalMagneticFieldIntensity
Defines a TotalMagneticFieldIntensity.

Declaration Syntax
public class TotalMagneticFieldIntensity : ElectromagneticResult

Table 401: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1460) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1457
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)
Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1460) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1458 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalMagneticFieldIntensity

Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MaximumOfMinimumOverTime (p. 922) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property Minimum (p. 923) Gets the Minimum.

(Inherited from Result (p. 916).)


Property MinimumOccursOn (p. 923) Gets the MinimumOccursOn.

(Inherited from Result (p. 916).)


Property MinimumOfMaximumOverTime (p. 923) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 916).)


Property MinimumOfMinimumOverTime (p. 923) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 916).)


Property PlotData (p. 923) Gets the result table.

(Inherited from Result (p. 916).)


Property RpmSetNumber (p. 923) Gets or sets the RpmSetNumber.

(Inherited from Result (p. 916).)


Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.

(Inherited from Result (p. 916).)


Property SetNumber (p. 924) Gets or sets the Set Number.

(Inherited from Result (p. 916).)


Property SolutionCombinationDriver (p. 924) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 916).)


Property SolverComponentIDs (p. 924) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 916).)


Property Substep (p. 924) Gets the Substep.

(Inherited from Result (p. 916).)


Property Suppressed (p. 924) Gets or sets the Suppressed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1459
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

(Inherited from Result (p. 916).)


Property TabularData (p. 925) Gets the tabular data of the result. Use a
to get index to each column of the tabular
data.

(Inherited from Result (p. 916).)


Property Time (p. 925) Gets the Time.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMaximumValues (p. 925) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMaximumOfMinimumValues (p. 925) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMaximumValues (p. 925) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property TimeForMinimumOfMinimumValues (p. 925) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 916).)

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; }

TotalMagneticFluxDensity
Defines a TotalMagneticFluxDensity.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1460 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalMagneticFluxDensity

Declaration Syntax
public class TotalMagneticFluxDensity : ElectromagneticResult

Table 402: Members

Property Average (p. 918) Gets the Average.

(Inherited from Result (p. 916).)


Property AverageAcrossBodies (p. 1442) Gets or sets the AverageAcrossBodies.

(Inherited from
ElectromagneticResult (p. 1439).)
Property By (p. 918) Gets or sets the By.

(Inherited from Result (p. 916).)


Property CalculateTimeHistory (p. 918) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 916).)


Property Children (p. 918) Gets the list of children.

(Inherited from Result (p. 916).)


Property CombinationNumber (p. 919) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 916).)


Property Comments (p. 919) Gets the list of associated comments.

(Inherited from Result (p. 916).)


Property CoordinateSystem (p. 919) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case.
Accepts/Returns None for Fiber
Coordinate System for a result that is sub
scoped by ply.

(Inherited from Result (p. 916).)


Property DataModelObjectCategory (p. 1464) Gets the current DataModelObject's
category.
Property DisplayOption (p. 919) Gets or sets the DisplayOption.

(Inherited from Result (p. 916).)


Property DisplayTime (p. 919) Gets or sets the DisplayTime.

(Inherited from Result (p. 916).)


Property ElectromagneticResultType (p. 1443) Gets or sets the
ElectromagneticResultType.

(Inherited from
ElectromagneticResult (p. 1439).)

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1461
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace

Property Figures (p. 920) Gets the list of associated figures.

(Inherited from Result (p. 916).)


Property GraphControlsXAxis (p. 920) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 916).)


Property Identifier (p. 920) Gets or sets the Identifier.

(Inherited from Result (p. 916).)


Property Images (p. 920) Gets the list of associated images.

(Inherited from Result (p. 916).)


Property InternalObject (p. 1464) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 920) Gets the IsSolved.

(Inherited from Result (p. 916).)


Property ItemType (p. 921) Gets or sets the ItemType.

(Inherited from Result (p. 916).)


Property IterationNumber (p. 921) Gets the IterationNumber.

(Inherited from Result (p. 916).)


Property LoadStep (p. 921) Gets the LoadStep.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMaximumValues (p. 921) Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMaximumOfMinimumValues (p. 921) Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMaximumValues (p. 921) Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 916).)


Property LoadStepForMinimumOfMinimumValues (p. 922) Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 916).)


Property Location (p. 922) Gets or sets the Location.

(Inherited from Result (p. 916).)


Property Maximum (p. 922) Gets the Maximum.

(Inherited from Result (p. 916).)


Property MaximumOccursOn (p. 922) Gets the MaximumOccursOn.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1462 of ANSYS, Inc. and its subsidiaries and affiliates.
TotalMagneticFluxDensity

(Inherited from Result (p. 916).)


Property MaximumOfMaximumOverTime (p. 922) Gets the MaximumOfMaximumOverTime.

You might also like