You are on page 1of 490

ANSYS Application Customization Toolkit

Reference Guide

ANSYS, Inc.
Southpointe
2600 ANSYS Drive
Canonsburg, PA 15317
ansysinfo@ansys.com
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494

Release 16.0
January 2015
ANSYS Customization Suite
ANSYS, Inc. is
certified to ISO
9001:2008.

Copyright and Trademark Information


2014-2015 SAS IP, Inc. All rights reserved. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, Ansoft, AUTODYN, EKM, Engineering Knowledge Manager, CFX, FLUENT, HFSS, AIM
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 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.

Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL 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. is certified to ISO 9001:2008.

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, please contact ANSYS, Inc.
Published in the U.S.A.

Table of Contents
I. Namespaces ............................................................................................................................................. 1
Ansys.AAP.Core Namespace ................................................................................................................. 3
ExtensionId ...................................................................................................................................... 3
UniqueId .................................................................................................................................... 3
Ansys.AAP.Core.Utilities Namespace ................................................................................................... 5
AttributeCollection ........................................................................................................................... 5
Item ........................................................................................................................................... 5
Keys ........................................................................................................................................... 6
Clone() ....................................................................................................................................... 6
Contains(string) .......................................................................................................................... 6
GetStringValue(string) ................................................................................................................ 6
GetValue(string) ......................................................................................................................... 6
GetValue(string, object) .............................................................................................................. 7
Remove(string) ........................................................................................................................... 7
SetValue(string, object) ............................................................................................................... 7
NamedCollection<T> ....................................................................................................................... 7
Item ........................................................................................................................................... 8
Names ........................................................................................................................................ 8
Ansys.ACT.Interfaces.Mechanical Namespace ..................................................................................... 9
IMechanicalDataModel ..................................................................................................................... 9
Project ....................................................................................................................................... 9
CurrentUnitFromQuantityName(string) ....................................................................................... 9
GetObjectById(int) .................................................................................................................... 10
IMechanicalExtAPI .......................................................................................................................... 10
LockPrePostLicense() ................................................................................................................ 10
UnlockPrePostLicense() ............................................................................................................. 10
IMechanicalUserLoad ...................................................................................................................... 11
IMechanicalUserObject ................................................................................................................... 11
Analysis .................................................................................................................................... 11
IMechanicalUserResult .................................................................................................................... 11
IMechanicalUserSolver .................................................................................................................... 11
MechanicalPanelEnum ................................................................................................................... 11
Ansys.ACT.Interfaces.DesignModeler Namespace ............................................................................. 13
IDesignModelerDataModel ............................................................................................................. 14
Components ............................................................................................................................ 14
GeoData ................................................................................................................................... 14
GeometryBuilder ...................................................................................................................... 14
Queries .................................................................................................................................... 15
ComponentById(int) ................................................................................................................. 15
CurrentUnitFromQuantityName(string) ..................................................................................... 15
IDesignModelerExtAPI .................................................................................................................... 15
IDesignModelerGeoData ................................................................................................................ 15
Bodies ...................................................................................................................................... 16
Parts ......................................................................................................................................... 16
IDesignModelerGeoFeature ............................................................................................................ 16
Bodies ...................................................................................................................................... 16
MaterialType ............................................................................................................................ 17
AddProblematicGeometry(IEnumerable<IPSGeoEntity>, string) ................................................ 17
IDesignModelerSelectionInfo .......................................................................................................... 17
Entities ..................................................................................................................................... 17
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

iii

ANSYS ACT Reference Guide


Locations .................................................................................................................................. 17
IExtrude ......................................................................................................................................... 18
Depth ....................................................................................................................................... 18
Direction .................................................................................................................................. 18
Walled ...................................................................................................................................... 18
ApplyTo(IPSGeoEntity) .............................................................................................................. 18
IGeometryBuilder ........................................................................................................................... 19
Operations ............................................................................................................................... 19
Primitives ................................................................................................................................. 19
IIntersect ........................................................................................................................................ 19
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 19
IOperations .................................................................................................................................... 20
Queries .................................................................................................................................... 20
Tools ........................................................................................................................................ 20
CreateExtrudeOperation(IEnumerable<double>, double) .......................................................... 20
CreateIntersectOperation(IEnumerable<IPSGeoBody>) ............................................................. 21
CreateRevolveOperation(IEnumerable<double>, IEnumerable<double>) .................................. 21
CreateSubtractOperation(IEnumerable<IPSGeoBody>) ............................................................. 21
CreateUnionOperation() ........................................................................................................... 22
IOperationTools .............................................................................................................................. 22
CopyBody(IPSGeoBody) ............................................................................................................ 22
CreatePart(IEnumerable<IPSGeoBody>) .................................................................................... 23
DeleteBody(IPSGeoBody) .......................................................................................................... 23
EdgesToWireBody(IEnumerable<IPSGeoEdge>) ........................................................................ 23
FacesToSheetBody(IEnumerable<IPSGeoFace>) ........................................................................ 23
Imprint(IPSGeoBody, IEnumerable<IPSGeoBody>) ..................................................................... 24
OffsetFace(IEnumerable<IPSGeoFace>, double) ........................................................................ 24
SheetBodyToSolidBody(IPSGeoBody) ........................................................................................ 24
SimplifyTopology(IPSGeoEntity) ................................................................................................ 24
ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, double, double) ..................................... 25
TransformBody(IPSGeoBody, Matrix4D) ..................................................................................... 25
WireToSheetBody(IPSGeoBody) ................................................................................................ 25
IPrimitives ...................................................................................................................................... 26
Sheet ....................................................................................................................................... 26
Solid ......................................................................................................................................... 26
Wire ......................................................................................................................................... 26
IPSGeoBody ................................................................................................................................... 26
IPSGeoEdge .................................................................................................................................... 27
IPSGeoEntity .................................................................................................................................. 27
IPSGeoFace .................................................................................................................................... 27
IPSGeoPart ..................................................................................................................................... 27
IQueries .......................................................................................................................................... 27
Clash(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) .............................................. 28
Coincidence(IPSGeoEntity, IPSGeoEntity) ................................................................................... 28
Containment(IPSGeoEntity, IPSGeoEntity) ................................................................................. 28
Distance(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) ......................................... 29
IRevolve ......................................................................................................................................... 29
Angle ....................................................................................................................................... 29
Axis .......................................................................................................................................... 29
Origin ....................................................................................................................................... 30
Walled ...................................................................................................................................... 30
ApplyTo(IPSGeoEntity) .............................................................................................................. 30

iv

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


ISheetCone ..................................................................................................................................... 30
Center ...................................................................................................................................... 30
Direction .................................................................................................................................. 31
Radius1 .................................................................................................................................... 31
Radius2 .................................................................................................................................... 31
ISheetCylinder ................................................................................................................................ 31
Center ...................................................................................................................................... 31
Direction .................................................................................................................................. 32
Radius ...................................................................................................................................... 32
ISheetPolygon ................................................................................................................................ 32
Points ....................................................................................................................................... 32
ISheets ........................................................................................................................................... 32
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ..................................... 33
CreatePolygon(IEnumerable<double>) ..................................................................................... 33
ISheetSphere .................................................................................................................................. 33
Center ...................................................................................................................................... 33
Radius ...................................................................................................................................... 34
ISolidBox ........................................................................................................................................ 34
Point1 ...................................................................................................................................... 34
Point2 ...................................................................................................................................... 34
ISolidCone ...................................................................................................................................... 34
Center ...................................................................................................................................... 35
Direction .................................................................................................................................. 35
Radius1 .................................................................................................................................... 35
Radius2 .................................................................................................................................... 35
ISolidCylinder ................................................................................................................................. 35
Center ...................................................................................................................................... 36
Direction .................................................................................................................................. 36
Radius ...................................................................................................................................... 36
ISolids ............................................................................................................................................ 36
CreateBox(IEnumerable<double>, IEnumerable<double>) ........................................................ 37
CreateCone(IEnumerable<double>, IEnumerable<double>, double, double) ............................. 37
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ..................................... 37
CreateSphere(IEnumerable<double>, double) ........................................................................... 38
ISolidSphere ................................................................................................................................... 38
Center ...................................................................................................................................... 38
Radius ...................................................................................................................................... 38
ISubtract ........................................................................................................................................ 39
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 39
IUnion ............................................................................................................................................ 39
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 39
IWireArc ......................................................................................................................................... 40
Center ...................................................................................................................................... 40
EndAngle ................................................................................................................................. 40
Normal ..................................................................................................................................... 40
Radius ...................................................................................................................................... 40
StartAngle ................................................................................................................................ 41
XDir .......................................................................................................................................... 41
IWireBCurve ................................................................................................................................... 41
Closed ...................................................................................................................................... 41
Points ....................................................................................................................................... 41
IWireEllipse ..................................................................................................................................... 42
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


Center ...................................................................................................................................... 42
LargeRadius ............................................................................................................................. 42
Normal ..................................................................................................................................... 42
SmallRadius .............................................................................................................................. 42
XDir .......................................................................................................................................... 43
IWirePolyline .................................................................................................................................. 43
Points ....................................................................................................................................... 43
IWires ............................................................................................................................................. 43
CreateArc(double, IEnumerable<double>, IEnumerable<double>, IEnumerable<double>) ......... 44
CreateBCurve(IEnumerable<double>) ....................................................................................... 44
CreateEllipse(double, double, IEnumerable<double>, IEnumerable<double>, IEnumerable<double>) ......................................................................................................................... 44
CreatePolyline(IEnumerable<double>) ...................................................................................... 45
Ansys.ACT.Automation.Mechanical Namespace ................................................................................ 47
CommandSnippet .......................................................................................................................... 47
Children ................................................................................................................................... 48
Comments ............................................................................................................................... 48
Figures ..................................................................................................................................... 49
InputArgument1 ...................................................................................................................... 49
InputArgument2 ...................................................................................................................... 49
InputArgument3 ...................................................................................................................... 49
InputArgument4 ...................................................................................................................... 49
InputArgument5 ...................................................................................................................... 49
InputArgument6 ...................................................................................................................... 50
InputArgument7 ...................................................................................................................... 50
InputArgument8 ...................................................................................................................... 50
InputArgument9 ...................................................................................................................... 50
SnippetFilePath ........................................................................................................................ 50
SnippetFileStatus ...................................................................................................................... 50
SolverTarget ............................................................................................................................. 50
Suppressed .............................................................................................................................. 51
AddComment() ........................................................................................................................ 51
AddFigure() .............................................................................................................................. 51
Comment ....................................................................................................................................... 51
Author ...................................................................................................................................... 51
Children ................................................................................................................................... 52
Text .......................................................................................................................................... 52
Component .................................................................................................................................... 52
Children ................................................................................................................................... 52
Comments ............................................................................................................................... 53
Figures ..................................................................................................................................... 53
Geometry ................................................................................................................................. 53
ImportedFromCAD ................................................................................................................... 53
IncludeProgramControlledInflation ........................................................................................... 53
NumberOfSuppressedItems ...................................................................................................... 53
RelativeTolerance ..................................................................................................................... 54
SendToSolver ........................................................................................................................... 54
ToleranceType .......................................................................................................................... 54
TotalSelection ........................................................................................................................... 54
UsedByMeshWorksheet ............................................................................................................ 54
Visible ...................................................................................................................................... 54
ZeroTolerance .......................................................................................................................... 54

vi

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


AddComment() ........................................................................................................................ 55
AddFigure() .............................................................................................................................. 55
ComponentGroup .......................................................................................................................... 55
Children ................................................................................................................................... 55
Comments ............................................................................................................................... 56
Components ............................................................................................................................ 56
Figures ..................................................................................................................................... 56
GenerateOnRefresh .................................................................................................................. 56
GenerateOnRemesh ................................................................................................................. 56
RandomColors .......................................................................................................................... 56
ShowAnnotations ..................................................................................................................... 57
AddComment() ........................................................................................................................ 57
AddFigure() .............................................................................................................................. 57
CondensedPart ............................................................................................................................... 57
Children ................................................................................................................................... 58
FutureIntent ............................................................................................................................. 58
GeometrySelection ................................................................................................................... 58
InterfaceMethod ....................................................................................................................... 58
InteriorConnections .................................................................................................................. 58
MaxFrequency .......................................................................................................................... 59
MinFrequency .......................................................................................................................... 59
NumberOfModes ...................................................................................................................... 59
NumInterfaceEntries ................................................................................................................. 59
NumMasterNodes .................................................................................................................... 59
Physics ..................................................................................................................................... 59
RangeSearch ............................................................................................................................ 59
ReductionMethod .................................................................................................................... 60
ReferenceTemperature ............................................................................................................. 60
SolutionName .......................................................................................................................... 60
SolutionNameMode ................................................................................................................. 60
SolverFilesDirectory .................................................................................................................. 60
Suppressed .............................................................................................................................. 60
TemperatureUnits ..................................................................................................................... 61
ConstructionGeometry ................................................................................................................... 61
Children ................................................................................................................................... 61
Comments ............................................................................................................................... 61
Figures ..................................................................................................................................... 61
Paths ........................................................................................................................................ 62
ShowMesh ............................................................................................................................... 62
AddComment() ........................................................................................................................ 62
AddFigure() .............................................................................................................................. 62
CoordinateSystem .......................................................................................................................... 62
Children ................................................................................................................................... 63
Comments ............................................................................................................................... 63
CoordinateSystemType ............................................................................................................. 63
EulerAngleXY ........................................................................................................................... 63
EulerAngleYZ ........................................................................................................................... 63
EulerAngleZX ........................................................................................................................... 63
Figures ..................................................................................................................................... 64
GloballyAvailable ...................................................................................................................... 64
IsGlobal .................................................................................................................................... 64
ReadOnly ................................................................................................................................. 64
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

vii

ANSYS ACT Reference Guide


Suppressed .............................................................................................................................. 64
AddComment() ........................................................................................................................ 64
AddFigure() .............................................................................................................................. 65
CoordinateSystemGroup ................................................................................................................ 65
Children ................................................................................................................................... 65
Comments ............................................................................................................................... 65
CoordinateSystems ................................................................................................................... 65
Figures ..................................................................................................................................... 66
AddComment() ........................................................................................................................ 66
AddFigure() .............................................................................................................................. 66
Environment .................................................................................................................................. 66
CellId ........................................................................................................................................ 67
Children ................................................................................................................................... 67
Comments ............................................................................................................................... 67
Figures ..................................................................................................................................... 67
Solution ................................................................................................................................... 67
SolverName .............................................................................................................................. 67
SystemCaption ......................................................................................................................... 68
Temperature ............................................................................................................................. 68
WorkingDir ............................................................................................................................... 68
AddComment() ........................................................................................................................ 68
AddEarthGravity() ..................................................................................................................... 68
AddFigure() .............................................................................................................................. 68
AddFixedSupport() ................................................................................................................... 68
Figure ............................................................................................................................................. 69
Children ................................................................................................................................... 69
Comments ............................................................................................................................... 69
Text .......................................................................................................................................... 69
AddComment() ........................................................................................................................ 69
MeshControlGroup ......................................................................................................................... 70
AdvancedInflation .................................................................................................................... 71
AdvancedSizeFunction ............................................................................................................. 71
AutomaticInflation .................................................................................................................... 72
AutoMeshDefeaturing .............................................................................................................. 72
Children ................................................................................................................................... 72
Comments ............................................................................................................................... 72
DefeatureTolerance .................................................................................................................. 72
DisplayStyle .............................................................................................................................. 72
ElementCount .......................................................................................................................... 73
ElementOrder ........................................................................................................................... 73
ElementSize .............................................................................................................................. 73
ExpansionFactor ....................................................................................................................... 73
ExtraRetriesForAssembly ........................................................................................................... 73
Figures ..................................................................................................................................... 73
GrowthRateSF .......................................................................................................................... 73
InflationAlgorithm .................................................................................................................... 74
InflationOption ......................................................................................................................... 74
InitialSizeSeed .......................................................................................................................... 74
MaxFaceElementSize ................................................................................................................ 74
MaximumLayers ....................................................................................................................... 74
MaxSizeSF ................................................................................................................................ 74
MeshControls ........................................................................................................................... 75

viii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


MeshMetric .............................................................................................................................. 75
MeshMetricAverage .................................................................................................................. 75
MeshMetricMax ........................................................................................................................ 75
MeshMetricMin ........................................................................................................................ 75
MeshMetricSTDV ...................................................................................................................... 75
MeshMorphing ......................................................................................................................... 75
MinEdgeSize ............................................................................................................................. 76
MinSizeSF ................................................................................................................................. 76
NodeCount ............................................................................................................................... 76
NumberOfRetries ...................................................................................................................... 76
NumCpuPartMeshing ............................................................................................................... 76
PhysicsPreference ..................................................................................................................... 76
PinchGenerateOnRefresh .......................................................................................................... 77
PinchTolerance ......................................................................................................................... 77
Relevance ................................................................................................................................. 77
RelevanceCenter ....................................................................................................................... 77
RigidBodyBehavior ................................................................................................................... 77
ShapeChecking ........................................................................................................................ 77
SmoothingOption .................................................................................................................... 77
SolverPreference ...................................................................................................................... 78
SpanAngleOption ..................................................................................................................... 78
SpanningAngleSF ..................................................................................................................... 78
StraightSideElement ................................................................................................................. 78
TopologyChecks ....................................................................................................................... 78
TransitionOption ...................................................................................................................... 78
TransitionRatio ......................................................................................................................... 79
TriangleSurfaceMesh ................................................................................................................ 79
AddComment() ........................................................................................................................ 79
AddContactSizingMeshControl() ............................................................................................... 79
AddFaceMeshingMeshControl() ................................................................................................ 79
AddFigure() .............................................................................................................................. 79
AddInflationMeshControl() ....................................................................................................... 79
AddMatchMeshControl() ........................................................................................................... 80
AddMethodMeshControl() ........................................................................................................ 80
AddPinchMeshControl() ............................................................................................................ 80
AddRefinementMeshControl() .................................................................................................. 80
AddSizingMeshControl() ........................................................................................................... 80
Model ............................................................................................................................................ 80
CellId ........................................................................................................................................ 81
Children ................................................................................................................................... 81
Comments ............................................................................................................................... 81
ComponentGroup .................................................................................................................... 82
ConnectionGroup ..................................................................................................................... 82
CoordinateSystemGroup .......................................................................................................... 82
Environments ........................................................................................................................... 82
Figures ..................................................................................................................................... 82
MeshControlGroup ................................................................................................................... 82
PrototypeGroup ....................................................................................................................... 82
Prototypes ................................................................................................................................ 83
RemotePointGroup ................................................................................................................... 83
SystemCaption ......................................................................................................................... 83
AddComment() ........................................................................................................................ 83
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ix

ANSYS ACT Reference Guide


AddFigure() .............................................................................................................................. 83
AddRemotePointGroup() .......................................................................................................... 83
Path ............................................................................................................................................... 84
Children ................................................................................................................................... 84
Comments ............................................................................................................................... 84
CoordinateSystemSelection ...................................................................................................... 85
EdgeSelection .......................................................................................................................... 85
EndCoordinateSystemSelection ................................................................................................ 85
EndLocationX ........................................................................................................................... 85
EndLocationY ........................................................................................................................... 85
EndLocationZ ........................................................................................................................... 85
Figures ..................................................................................................................................... 86
HasValidGeometrySelection ...................................................................................................... 86
NumberOfSamplingPoints ........................................................................................................ 86
PathScopingType ...................................................................................................................... 86
ShowMesh ............................................................................................................................... 86
SnapToMesh ............................................................................................................................. 86
StartCoordinateSystemSelection ............................................................................................... 86
StartLocationX .......................................................................................................................... 87
StartLocationY .......................................................................................................................... 87
StartLocationZ .......................................................................................................................... 87
Suppressed .............................................................................................................................. 87
AddComment() ........................................................................................................................ 87
AddFigure() .............................................................................................................................. 87
PointMass ....................................................................................................................................... 88
AppliedBy ................................................................................................................................ 88
Behavior ................................................................................................................................... 88
Children ................................................................................................................................... 89
Comments ............................................................................................................................... 89
CoordinateSystem .................................................................................................................... 89
DistributedMassInputType ........................................................................................................ 89
Figures ..................................................................................................................................... 89
IsDistributedMass ..................................................................................................................... 89
Mass ......................................................................................................................................... 90
MassMomentOfInertiaX ............................................................................................................ 90
MassMomentOfInertiaY ............................................................................................................ 90
MassMomentOfInertiaZ ............................................................................................................ 90
MassPerUnitArea ...................................................................................................................... 90
PinballSize ................................................................................................................................ 90
Prototypes ................................................................................................................................ 90
RemotePoint ............................................................................................................................ 91
Scope ....................................................................................................................................... 91
Suppressed .............................................................................................................................. 91
ThermalCapacitance ................................................................................................................. 91
TotalMass ................................................................................................................................. 91
AddComment() ........................................................................................................................ 91
AddFigure() .............................................................................................................................. 92
Project ........................................................................................................................................... 92
Author ...................................................................................................................................... 92
Children ................................................................................................................................... 92
Comments ............................................................................................................................... 92
CreationDate ............................................................................................................................ 93

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


CreationTime ............................................................................................................................ 93
Models ..................................................................................................................................... 93
PreparedFor ............................................................................................................................. 93
Subject ..................................................................................................................................... 93
AddComment() ........................................................................................................................ 93
Prototype ....................................................................................................................................... 94
BoundingBoxLengthX .............................................................................................................. 95
BoundingBoxLengthY ............................................................................................................... 95
BoundingBoxLengthZ ............................................................................................................... 95
Children ................................................................................................................................... 95
Comments ............................................................................................................................... 95
CoordinateSystem .................................................................................................................... 95
CrossSectionArea ..................................................................................................................... 96
Elements .................................................................................................................................. 96
Figures ..................................................................................................................................... 96
IsWindingBody ......................................................................................................................... 96
Mass ......................................................................................................................................... 96
MassCentroidX ......................................................................................................................... 96
MassCentroidY ......................................................................................................................... 97
MassCentroidZ ......................................................................................................................... 97
MassMomentOfInertiaP1 .......................................................................................................... 97
MassMomentOfInertiaP2 .......................................................................................................... 97
MassMomentOfInertiaP3 .......................................................................................................... 97
MaterialAssignment .................................................................................................................. 97
MeshMetric .............................................................................................................................. 97
Nodes ...................................................................................................................................... 98
NonlinearMaterialEffects ........................................................................................................... 98
ReadOnly ................................................................................................................................. 98
ReferenceTemperature ............................................................................................................. 98
StiffnessBehavior ...................................................................................................................... 98
Suppressed .............................................................................................................................. 98
ThermalStrainMaterialEffects .................................................................................................... 99
Thickness ................................................................................................................................. 99
ThicknessMode ........................................................................................................................ 99
UseReferenceTemperature ........................................................................................................ 99
UserNameChange .................................................................................................................... 99
Version ..................................................................................................................................... 99
Visible ...................................................................................................................................... 99
Volume ................................................................................................................................... 100
WireLength ............................................................................................................................ 100
AddComment() ....................................................................................................................... 100
AddFigure() ............................................................................................................................ 100
PrototypeGroup ........................................................................................................................... 100
BoundingBoxLengthX ............................................................................................................. 102
BoundingBoxLengthY ............................................................................................................. 102
BoundingBoxLengthZ ............................................................................................................. 102
CADAttribPrefixes ................................................................................................................... 102
CADFile .................................................................................................................................. 102
CADNamedSelPrefixes ............................................................................................................ 102
CanChangeCADUnits .............................................................................................................. 102
Children ................................................................................................................................. 103
Comments .............................................................................................................................. 103
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xi

ANSYS ACT Reference Guide


DoSmartUpdate ..................................................................................................................... 103
Elements ................................................................................................................................ 103
FiberLength ............................................................................................................................ 103
Figures ................................................................................................................................... 103
GeometryPreferencesReadOnly .............................................................................................. 104
GeometryType ........................................................................................................................ 104
ImportCoordinateSystems ...................................................................................................... 104
ImportEnclosureAndSymmetry ............................................................................................... 104
ImportSheets .......................................................................................................................... 104
ImportSolids ........................................................................................................................... 104
ImportWires ........................................................................................................................... 104
Mass ....................................................................................................................................... 105
MeshVolume .......................................................................................................................... 105
Model2DBehavior ................................................................................................................... 105
Nodes ..................................................................................................................................... 105
NumActiveParts ...................................................................................................................... 105
NumParts ............................................................................................................................... 105
PointMasses ........................................................................................................................... 106
Prototypes .............................................................................................................................. 106
SurfaceArea ............................................................................................................................ 106
UseCADAssociativity ............................................................................................................... 106
UseCADAttribTrans ................................................................................................................. 106
UseCADNamedSelTrans .......................................................................................................... 106
Volume ................................................................................................................................... 106
XCentroid ............................................................................................................................... 107
YCentroid ............................................................................................................................... 107
ZCentroid ............................................................................................................................... 107
AddComment() ....................................................................................................................... 107
AddFigure() ............................................................................................................................ 107
AddPointMass() ...................................................................................................................... 107
RemotePoint ................................................................................................................................ 108
Behavior ................................................................................................................................. 108
Children ................................................................................................................................. 108
Comments .............................................................................................................................. 109
ComponentXActiveOrInactive ................................................................................................. 109
ComponentYActiveOrInactive ................................................................................................. 109
ComponentZActiveOrInactive ................................................................................................. 109
CoordinateSystem .................................................................................................................. 109
DOFSelection ......................................................................................................................... 109
GloballyAvailable .................................................................................................................... 110
LocationX ............................................................................................................................... 110
LocationY ............................................................................................................................... 110
LocationZ ............................................................................................................................... 110
PinballSize .............................................................................................................................. 110
RotationXActiveOrInactive ...................................................................................................... 110
RotationYActiveOrInactive ...................................................................................................... 110
RotationZActiveOrInactive ...................................................................................................... 111
Scope ..................................................................................................................................... 111
Suppressed ............................................................................................................................ 111
AddComment() ....................................................................................................................... 111
GetMeshRegion() .................................................................................................................... 111
RemotePointGroup ....................................................................................................................... 111

xii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


Children ................................................................................................................................. 112
Comments .............................................................................................................................. 112
RemotePoints ......................................................................................................................... 112
ShowLines .............................................................................................................................. 112
AddComment() ....................................................................................................................... 112
AddRemotePoint() .................................................................................................................. 113
Solution ....................................................................................................................................... 113
CellId ...................................................................................................................................... 113
Children ................................................................................................................................. 113
Comments .............................................................................................................................. 114
Figures ................................................................................................................................... 114
Results ................................................................................................................................... 114
WorkingDir ............................................................................................................................. 114
AddComment() ....................................................................................................................... 114
AddDeformation() .................................................................................................................. 114
AddFigure() ............................................................................................................................ 114
Ansys.ACT.Automation.Mechanical.Results Namespace ................................................................. 117
Deformation ................................................................................................................................. 117
Maximum ............................................................................................................................... 118
Minimum ............................................................................................................................... 118
Type ....................................................................................................................................... 118
Result ........................................................................................................................................... 118
CalculateTimeHistory .............................................................................................................. 119
Children ................................................................................................................................. 119
Comments .............................................................................................................................. 119
DisplayTime ............................................................................................................................ 119
Figures ................................................................................................................................... 119
GeometrySelection ................................................................................................................. 120
Identifier ................................................................................................................................ 120
SetDriver ................................................................................................................................ 120
Suppressed ............................................................................................................................ 120
AddComment() ....................................................................................................................... 120
AddFigure() ............................................................................................................................ 120
Ansys.ACT.Automation.Mechanical.Enums Namespace .................................................................. 121
ActiveInactive ............................................................................................................................... 122
AutoDetectionType ...................................................................................................................... 123
AutoOrManual .............................................................................................................................. 123
CommandEditorTarget ................................................................................................................. 123
CondensedPartInterfaceMethod ................................................................................................... 124
CondensedPartPhysics .................................................................................................................. 124
CondensedPartReductionMethod ................................................................................................. 124
ConnectionScopingType ............................................................................................................... 124
ContactBehavior ........................................................................................................................... 125
ContactCorrection ........................................................................................................................ 125
ContactDetectionPoint ................................................................................................................. 125
ContactEdgeEdgeOption .............................................................................................................. 126
ContactElasticSlipToleranceType ................................................................................................... 126
ContactFaceEdgeOption ............................................................................................................... 126
ContactFaceEdgePriority ............................................................................................................... 127
ContactFormulationType .............................................................................................................. 127
ContactGroupingType .................................................................................................................. 127
ContactInitialEffect ....................................................................................................................... 128
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xiii

ANSYS ACT Reference Guide


ContactOrientation ....................................................................................................................... 128
ContactPenetrationToleranceType ................................................................................................ 128
ContactPinballType ....................................................................................................................... 128
ContactSearchingType .................................................................................................................. 129
ContactToleranceType .................................................................................................................. 129
ContactTrimType .......................................................................................................................... 129
ContactType ................................................................................................................................. 130
ContectDetection ......................................................................................................................... 130
CoordinateSystemType ................................................................................................................. 131
CrossSectionType ......................................................................................................................... 131
DeformationType ......................................................................................................................... 131
DistributedMassInputType ............................................................................................................ 131
DOFSelectionType ........................................................................................................................ 132
FutureIntent ................................................................................................................................. 132
GeometryDefineByType ................................................................................................................ 132
GeometryType .............................................................................................................................. 133
JointInitialPosition ........................................................................................................................ 133
JointScopingType ......................................................................................................................... 133
JointSolverElementType ............................................................................................................... 134
JointStopType .............................................................................................................................. 134
JointType ...................................................................................................................................... 134
LoadBehaviorType ........................................................................................................................ 135
MeshDisplayStyle ......................................................................................................................... 135
Model2DBehavior ......................................................................................................................... 136
PathScoping ................................................................................................................................. 136
RemoteApplicationType ............................................................................................................... 136
RotationPlane ............................................................................................................................... 136
SetDriverStyle ............................................................................................................................... 137
SpringBehavior ............................................................................................................................. 137
SpringPreloadType ....................................................................................................................... 138
SpringResultType .......................................................................................................................... 138
SpringScopingType ...................................................................................................................... 138
SpringStiffnessType ...................................................................................................................... 138
SpringType ................................................................................................................................... 139
StiffnessBehavior .......................................................................................................................... 139
TargetCorrection ........................................................................................................................... 139
TargetOrientation ......................................................................................................................... 140
ToleranceType .............................................................................................................................. 140
UpdateContactStiffness ................................................................................................................ 140
Ansys.AAP.DesignModeler.Primitives.Sheet Namespace ................................................................ 143
Cylinder ........................................................................................................................................ 143
Cylinder(GeometryBuilder, IEnumerable<double>, IEnumerable<double>, double) .................. 143
Center .................................................................................................................................... 144
Direction ................................................................................................................................ 144
Radius .................................................................................................................................... 144
Generate() .............................................................................................................................. 144
Ansys.ACT.Automation.Mechanical.MeshControls Namespace ...................................................... 145
ContactSizingMeshControl ........................................................................................................... 145
ContactRegion ........................................................................................................................ 146
ElementSize ............................................................................................................................ 146
Relevance ............................................................................................................................... 146
Type ....................................................................................................................................... 146

xiv

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


FaceMeshingMeshControl ............................................................................................................. 146
ConstrainBoundary ................................................................................................................. 147
GeometrySelection ................................................................................................................. 147
MappedMeshOption .............................................................................................................. 147
Method .................................................................................................................................. 148
NumberOfDivisions ................................................................................................................ 148
SpecifiedCorners .................................................................................................................... 148
SpecifiedEnds ......................................................................................................................... 148
SpecifiedSides ........................................................................................................................ 148
InflationMeshControl .................................................................................................................... 148
Boundary ............................................................................................................................... 149
FirstLayerHeight ..................................................................................................................... 149
GeometrySelection ................................................................................................................. 149
GrowthRate ............................................................................................................................ 150
InflationAlgorithm .................................................................................................................. 150
InflationOption ....................................................................................................................... 150
MaximumLayers ..................................................................................................................... 150
MaximumThickness ................................................................................................................ 150
NumLayers ............................................................................................................................. 150
TransitionRatio ....................................................................................................................... 151
MatchMeshControl ....................................................................................................................... 151
ControlMessages .................................................................................................................... 151
HighCoordinateSystem ........................................................................................................... 152
HighGeometrySelection ......................................................................................................... 152
LowCoordinateSystem ............................................................................................................ 152
LowGeometrySelection .......................................................................................................... 152
RotationAxis ........................................................................................................................... 152
Transformation ....................................................................................................................... 152
MeshControl ................................................................................................................................. 152
Children ................................................................................................................................. 153
Comments .............................................................................................................................. 153
Figures ................................................................................................................................... 153
Suppressed ............................................................................................................................ 153
AddComment() ....................................................................................................................... 153
AddFigure() ............................................................................................................................ 154
MethodMeshControl .................................................................................................................... 154
Algorithm ............................................................................................................................... 155
ApproxNumElements ............................................................................................................. 155
BFCartCoordSys ...................................................................................................................... 156
BFCartSpacingOption ............................................................................................................. 156
BFCartSubType ....................................................................................................................... 156
BFCartTolerance ..................................................................................................................... 156
ControlMessages .................................................................................................................... 156
CurvatureNormalAngle ........................................................................................................... 156
DefeaturingTolerance ............................................................................................................. 157
DefineDefeaturingTolerance ................................................................................................... 157
DefineType ............................................................................................................................. 157
ElementMidsideNodes ............................................................................................................ 157
FeatureAngle .......................................................................................................................... 157
FreeFaceMeshType ................................................................................................................. 157
FreeMeshType ........................................................................................................................ 157
KeyPoints ............................................................................................................................... 158
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xv

ANSYS ACT Reference Guide


Location ................................................................................................................................. 158
MappedMeshType .................................................................................................................. 158
MaxElementSize ..................................................................................................................... 158
Method .................................................................................................................................. 158
MethodElementOption ........................................................................................................... 158
MinEdgeSize ........................................................................................................................... 159
MinElementSize ...................................................................................................................... 159
NDiv ....................................................................................................................................... 159
NumCellsAcrossGap ................................................................................................................ 159
PreserveBoundaries ................................................................................................................ 159
ProjectionFactor ..................................................................................................................... 159
Refinement ............................................................................................................................. 159
ReuseBlocking ........................................................................................................................ 160
SourceGeometry .................................................................................................................... 160
SourceTargetSelection ............................................................................................................ 160
SurfaceMeshMethod .............................................................................................................. 160
SweepBiasType ....................................................................................................................... 160
SweepBiasValue ...................................................................................................................... 160
SweepEdges ........................................................................................................................... 161
SweepElementSize ................................................................................................................. 161
SweepESizeType ..................................................................................................................... 161
SweepSizeBehavior ................................................................................................................. 161
TargetGeometry ..................................................................................................................... 161
TetraGrowthRate .................................................................................................................... 161
TetraTransition ........................................................................................................................ 161
WriteICEMCFDFiles ................................................................................................................. 162
PinchMeshControl ........................................................................................................................ 162
AutoManualMode ................................................................................................................... 162
MasterGeometry ..................................................................................................................... 163
SlaveGeometry ....................................................................................................................... 163
Tolerance ................................................................................................................................ 163
RefinementMeshControl ............................................................................................................... 163
Location ................................................................................................................................. 164
Refinement ............................................................................................................................. 164
SizingMeshControl ....................................................................................................................... 164
Behavior ................................................................................................................................. 165
BiasEdges ............................................................................................................................... 165
BiasFactor ............................................................................................................................... 165
BiasGrowthRate ...................................................................................................................... 165
BiasOption .............................................................................................................................. 165
BiasType ................................................................................................................................. 166
CurvatureAngle ...................................................................................................................... 166
ElementSize ............................................................................................................................ 166
GrowthRate ............................................................................................................................ 166
LocalMinSize .......................................................................................................................... 166
Location ................................................................................................................................. 166
NumberOfDivisions ................................................................................................................ 167
SphereCenter ......................................................................................................................... 167
SphereCenterX ....................................................................................................................... 167
SphereCenterY ....................................................................................................................... 167
SphereCenterZ ....................................................................................................................... 167
SphereRadius ......................................................................................................................... 167

xvi

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


Type ....................................................................................................................................... 167
Ansys.ACT.Automation.DesignModeler Namespace ....................................................................... 169
Extrusion ...................................................................................................................................... 169
Depth ..................................................................................................................................... 169
Depth2 ................................................................................................................................... 170
Thin1 ...................................................................................................................................... 170
Thin2 ...................................................................................................................................... 170
Walled .................................................................................................................................... 170
Feature ......................................................................................................................................... 170
Id ........................................................................................................................................... 171
Name ..................................................................................................................................... 171
FeatureManager ........................................................................................................................... 171
Count ..................................................................................................................................... 171
Item ....................................................................................................................................... 171
CreateNamedSelection() ......................................................................................................... 171
Generate() .............................................................................................................................. 172
NamedSelection ........................................................................................................................... 172
ExportNamedSelection ........................................................................................................... 172
IncludeInLegend ..................................................................................................................... 172
NumGeometry ....................................................................................................................... 173
PropagateNamedSelection ..................................................................................................... 173
Ansys.ACT.Automation.Mechanical.Connections Namespace ......................................................... 175
BeamConnection .......................................................................................................................... 175
Children ................................................................................................................................. 176
Comments .............................................................................................................................. 176
CrossSectionType ................................................................................................................... 176
Figures ................................................................................................................................... 177
Hidden ................................................................................................................................... 177
MaterialName ......................................................................................................................... 177
MobileAppliedBy .................................................................................................................... 177
MobileBehavior ...................................................................................................................... 177
MobileBodyName ................................................................................................................... 177
MobileCoordinateSystemSelection ......................................................................................... 177
MobileLocation ...................................................................................................................... 178
MobileLocationX .................................................................................................................... 178
MobileLocationY .................................................................................................................... 178
MobileLocationZ .................................................................................................................... 178
MobilePinballSize ................................................................................................................... 178
Prototypes .............................................................................................................................. 178
Radius .................................................................................................................................... 179
ReferenceAppliedBy ............................................................................................................... 179
ReferenceBehavior .................................................................................................................. 179
ReferenceBodyName .............................................................................................................. 179
ReferenceCoordinateSystemSelection ..................................................................................... 179
ReferenceLocation .................................................................................................................. 179
ReferenceLocationPoint .......................................................................................................... 179
ReferenceLocationX ................................................................................................................ 180
ReferenceLocationY ................................................................................................................ 180
ReferenceLocationZ ................................................................................................................ 180
ReferencePinballSize ............................................................................................................... 180
ScopingType ........................................................................................................................... 180
Suppressed ............................................................................................................................ 180
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xvii

ANSYS ACT Reference Guide


AddComment() ....................................................................................................................... 181
AddFigure() ............................................................................................................................ 181
Bearing ......................................................................................................................................... 181
AnsBCType ............................................................................................................................. 182
Children ................................................................................................................................. 182
Comments .............................................................................................................................. 182
DampingC11 .......................................................................................................................... 182
DampingC12 .......................................................................................................................... 183
DampingC21 .......................................................................................................................... 183
DampingC22 .......................................................................................................................... 183
Figures ................................................................................................................................... 183
MobileBehavior ...................................................................................................................... 183
MobileBodyName ................................................................................................................... 183
MobileCoordinateSystem ........................................................................................................ 183
MobileLocation ...................................................................................................................... 184
MobileLocationX .................................................................................................................... 184
MobileLocationY .................................................................................................................... 184
MobileLocationZ .................................................................................................................... 184
MobilePinballSize ................................................................................................................... 184
Prototypes .............................................................................................................................. 184
ReferenceBehavior .................................................................................................................. 185
ReferenceBodyName .............................................................................................................. 185
ReferenceCoordinateSystem ................................................................................................... 185
ReferencePinballSize ............................................................................................................... 185
ReferenceRotationPlane .......................................................................................................... 185
ReferenceSet .......................................................................................................................... 185
ScopingType ........................................................................................................................... 185
StiffnessK11 ............................................................................................................................ 186
StiffnessK12 ............................................................................................................................ 186
StiffnessK21 ............................................................................................................................ 186
StiffnessK22 ............................................................................................................................ 186
Suppressed ............................................................................................................................ 186
AddComment() ....................................................................................................................... 186
AddFigure() ............................................................................................................................ 187
ConnectionGroup ......................................................................................................................... 187
BeamConnections .................................................................................................................. 187
Bearings ................................................................................................................................. 188
Children ................................................................................................................................. 188
Comments .............................................................................................................................. 188
ContactRegions ...................................................................................................................... 188
DetectionMode ...................................................................................................................... 188
Figures ................................................................................................................................... 188
FixedJoints ............................................................................................................................. 189
Joints ..................................................................................................................................... 189
MeshConnections ................................................................................................................... 189
Springs ................................................................................................................................... 189
TransparencyEnabled ............................................................................................................. 189
AddBeamConnection() ........................................................................................................... 189
AddBearing() .......................................................................................................................... 189
AddComment() ....................................................................................................................... 190
AddContactGroup() ................................................................................................................ 190
AddFigure() ............................................................................................................................ 190

xviii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


AddSpring() ............................................................................................................................ 190
ContactGroup ............................................................................................................................... 190
AutoFixedJoints ...................................................................................................................... 191
AutoRevoluteJoints ................................................................................................................ 191
BeamConnections .................................................................................................................. 192
Children ................................................................................................................................. 192
Comments .............................................................................................................................. 192
ContactRegions ...................................................................................................................... 192
FaceEdgePriority ..................................................................................................................... 192
Figures ................................................................................................................................... 192
GeometrySelection ................................................................................................................. 192
GroupingType ........................................................................................................................ 193
Joints ..................................................................................................................................... 193
MinDistanceSlider ................................................................................................................... 193
MinDistanceValue ................................................................................................................... 193
SearchingType ........................................................................................................................ 193
Springs ................................................................................................................................... 193
Suppressed ............................................................................................................................ 194
ThicknessScaleFactor .............................................................................................................. 194
ToleranceSlider ....................................................................................................................... 194
ToleranceType ........................................................................................................................ 194
ToleranceValue ....................................................................................................................... 194
UseEdgeEdge ......................................................................................................................... 194
UseFaceEdge .......................................................................................................................... 194
UseFaceFace ........................................................................................................................... 195
UseRange ............................................................................................................................... 195
AddComment() ....................................................................................................................... 195
AddFigure() ............................................................................................................................ 195
ContactRegion .............................................................................................................................. 195
AutoDetectionValue ............................................................................................................... 197
BeamMaterialName ................................................................................................................ 197
BeamRadius ........................................................................................................................... 197
Children ................................................................................................................................. 197
Comments .............................................................................................................................. 197
ContactCenterPoint ................................................................................................................ 197
ContactCorrection .................................................................................................................. 198
ContactEndingPoint ............................................................................................................... 198
ContactFormulation ................................................................................................................ 198
ContactOrientation ................................................................................................................. 198
ContactStartingPoint .............................................................................................................. 198
ContactType ........................................................................................................................... 198
DampingFactor ....................................................................................................................... 199
DetectionMethod ................................................................................................................... 199
ElasticSlipTolerance ................................................................................................................ 199
ElasticSlipToleranceFactor ....................................................................................................... 199
Figures ................................................................................................................................... 199
InterfaceTreatment ................................................................................................................. 199
Mode ..................................................................................................................................... 199
NormalStiffness ...................................................................................................................... 200
PenetrationTolerance .............................................................................................................. 200
PenetrationToleranceFactor .................................................................................................... 200
PinballFactor .......................................................................................................................... 200
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xix

ANSYS ACT Reference Guide


PinballRadius .......................................................................................................................... 200
PinballType ............................................................................................................................. 200
SourceComponentSelection ................................................................................................... 201
SourceGeometry .................................................................................................................... 201
SourceName ........................................................................................................................... 201
Suppressed ............................................................................................................................ 201
SymmetricContact .................................................................................................................. 201
TargetCenterPoint ................................................................................................................... 201
TargetComponentSelection .................................................................................................... 201
TargetCorrection ..................................................................................................................... 202
TargetEndingPoint .................................................................................................................. 202
TargetGeometry ..................................................................................................................... 202
TargetName ............................................................................................................................ 202
TargetOrientation ................................................................................................................... 202
TargetStartingPoint ................................................................................................................ 202
TrimContact ............................................................................................................................ 203
TrimTolerance ......................................................................................................................... 203
UpdateContactStiffness .......................................................................................................... 203
UseAutoElasticSlipTolerance ................................................................................................... 203
UseAutoNormalStiffness ......................................................................................................... 203
UseAutoPenetrationTolerance ................................................................................................. 203
UserOffset .............................................................................................................................. 203
AddComment() ....................................................................................................................... 204
AddFigure() ............................................................................................................................ 204
Joint ............................................................................................................................................. 204
Children ................................................................................................................................. 205
Comments .............................................................................................................................. 206
Figures ................................................................................................................................... 206
InitialPosition .......................................................................................................................... 206
JointBehaviorMobile ............................................................................................................... 206
JointBehaviorReference .......................................................................................................... 206
JointPinballSizeMobile ............................................................................................................ 206
JointPinballSizeReference ....................................................................................................... 207
JointScopingType ................................................................................................................... 207
JointStopsRXMax .................................................................................................................... 207
JointStopsRXMaxType ............................................................................................................ 207
JointStopsRXMin .................................................................................................................... 207
JointStopsRXMinType ............................................................................................................. 207
JointStopsRYMax .................................................................................................................... 207
JointStopsRYMaxType ............................................................................................................. 208
JointStopsRYMin .................................................................................................................... 208
JointStopsRYMinType ............................................................................................................. 208
JointStopsRZMax .................................................................................................................... 208
JointStopsRZMaxType ............................................................................................................. 208
JointStopsRZMin .................................................................................................................... 208
JointStopsRZMinType ............................................................................................................. 209
JointStopsXMax ...................................................................................................................... 209
JointStopsXMaxType .............................................................................................................. 209
JointStopsXMin ...................................................................................................................... 209
JointStopsXMinType ............................................................................................................... 209
JointStopsYMax ...................................................................................................................... 209
JointStopsYMaxType ............................................................................................................... 209

xx

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


JointStopsYMin ...................................................................................................................... 210
JointStopsYMinType ............................................................................................................... 210
JointStopsZMax ...................................................................................................................... 210
JointStopsZMaxType ............................................................................................................... 210
JointStopsZMin ...................................................................................................................... 210
JointStopsZMinType ............................................................................................................... 210
JointType ................................................................................................................................ 211
MobileAppliedBy .................................................................................................................... 211
MobileBodyName ................................................................................................................... 211
MobileCoordinateSystemSelection ......................................................................................... 211
MobileLocation ...................................................................................................................... 211
Prototypes .............................................................................................................................. 211
ReferenceAppliedBy ............................................................................................................... 211
ReferenceBodyName .............................................................................................................. 212
ReferenceCoordinateSystemSelection ..................................................................................... 212
ReferenceSet .......................................................................................................................... 212
SolverElementType ................................................................................................................. 212
Suppressed ............................................................................................................................ 212
SuppressedForSolve ............................................................................................................... 212
TortionalDamping .................................................................................................................. 213
TortionalStiffness .................................................................................................................... 213
AddComment() ....................................................................................................................... 213
AddFigure() ............................................................................................................................ 213
Spring .......................................................................................................................................... 213
Children ................................................................................................................................. 214
Comments .............................................................................................................................. 214
Figures ................................................................................................................................... 215
Hidden ................................................................................................................................... 215
LongitudinalDamping ............................................................................................................. 215
LongitudinalStiffness .............................................................................................................. 215
MobileAppliedBy .................................................................................................................... 215
MobileBodyName ................................................................................................................... 215
MobileCoordinateSystemSelection ......................................................................................... 216
MobileLocation ...................................................................................................................... 216
MobileLocationSelection ........................................................................................................ 216
MobileLocationX .................................................................................................................... 216
MobileLocationY .................................................................................................................... 216
MobileLocationZ .................................................................................................................... 216
PreloadLength ........................................................................................................................ 216
PreloadLoad ........................................................................................................................... 217
Prototypes .............................................................................................................................. 217
ReferenceAppliedBy ............................................................................................................... 217
ReferenceBodyName .............................................................................................................. 217
ReferenceCoordinateSystemSelection ..................................................................................... 217
ReferenceLocation .................................................................................................................. 217
ReferenceLocationSelection .................................................................................................... 218
ReferenceLocationX ................................................................................................................ 218
ReferenceLocationY ................................................................................................................ 218
ReferenceLocationZ ................................................................................................................ 218
SpringBehavior ....................................................................................................................... 218
SpringLength ......................................................................................................................... 218
SpringMobileBehavior ............................................................................................................ 218
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxi

ANSYS ACT Reference Guide


SpringMobilePinballSize ......................................................................................................... 219
SpringPreloadType ................................................................................................................. 219
SpringReferenceBehavior ........................................................................................................ 219
SpringReferencePinballSize ..................................................................................................... 219
SpringScopingType ................................................................................................................ 219
SpringType ............................................................................................................................. 219
Suppressed ............................................................................................................................ 220
AddComment() ....................................................................................................................... 220
AddFigure() ............................................................................................................................ 220
Ansys.AAP.Common Namespace ...................................................................................................... 221
CoordinateSystem ........................................................................................................................ 221
CoordinateSystem(CoordinateSystemTypeEnum) .................................................................... 221
CoordinateSystemType ........................................................................................................... 222
Id ........................................................................................................................................... 222
Matrix ..................................................................................................................................... 222
Name ..................................................................................................................................... 222
Origin ..................................................................................................................................... 222
XAxis ...................................................................................................................................... 222
YAxis ...................................................................................................................................... 223
ZAxis ...................................................................................................................................... 223
Ansys.ACT.Automation.Mechanical.Boundaries Namespace .......................................................... 225
Boundary ..................................................................................................................................... 225
Children ................................................................................................................................. 225
Comments .............................................................................................................................. 226
Figures ................................................................................................................................... 226
Magnitude ............................................................................................................................. 226
Suppressed ............................................................................................................................ 226
AddComment() ....................................................................................................................... 226
AddFigure() ............................................................................................................................ 226
EarthGravity ................................................................................................................................. 226
Children ................................................................................................................................. 227
Comments .............................................................................................................................. 227
CoordinateSystem .................................................................................................................. 227
Figures ................................................................................................................................... 227
GravityOrientation .................................................................................................................. 228
Suppressed ............................................................................................................................ 228
AddComment() ....................................................................................................................... 228
AddFigure() ............................................................................................................................ 228
FixedSupport ................................................................................................................................ 228
GeometrySelection ................................................................................................................. 229
Ansys.ACT.Interfaces.UserObject Namespace .................................................................................. 231
IPropertyCollection ....................................................................................................................... 231
Count ..................................................................................................................................... 232
Item ....................................................................................................................................... 232
Contains(ISimProperty) ........................................................................................................... 232
GetByName(string) ................................................................................................................. 232
ISimProperty ................................................................................................................................ 232
Attributes ............................................................................................................................... 233
Caption .................................................................................................................................. 233
Control ................................................................................................................................... 233
Controller ............................................................................................................................... 234
DefaultValue ........................................................................................................................... 234

xxii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


Displayed ............................................................................................................................... 234
HasUnit .................................................................................................................................. 234
Id ........................................................................................................................................... 234
InternalValue .......................................................................................................................... 234
IsGroup .................................................................................................................................. 235
IsTable .................................................................................................................................... 235
IsValid ..................................................................................................................................... 235
Name ..................................................................................................................................... 235
Options .................................................................................................................................. 235
ParentCaption ........................................................................................................................ 235
ParentPropertyGroup ............................................................................................................. 235
QuantityName ........................................................................................................................ 236
ReadOnly ................................................................................................................................ 236
UniqueName .......................................................................................................................... 236
UnitString ............................................................................................................................... 236
Value ...................................................................................................................................... 236
ValueString ............................................................................................................................. 236
Visible .................................................................................................................................... 237
ISimPropertyGroup ....................................................................................................................... 237
AllDescendants ....................................................................................................................... 237
Display ................................................................................................................................... 237
Properties ............................................................................................................................... 237
ISimPropertyTable ........................................................................................................................ 237
ActiveRow .............................................................................................................................. 238
RowCount .............................................................................................................................. 238
UpdateStateFreq .................................................................................................................... 238
ValidState ............................................................................................................................... 238
AddRow() ............................................................................................................................... 238
DeleteRow(int) ....................................................................................................................... 239
SaveActiveRow() ..................................................................................................................... 239
IUserLoad ..................................................................................................................................... 239
Children ................................................................................................................................. 239
Color ...................................................................................................................................... 240
IsLoad .................................................................................................................................... 240
IsSupport ............................................................................................................................... 240
Suppressed ............................................................................................................................ 240
CreateChild(string) .................................................................................................................. 240
IUserObject .................................................................................................................................. 240
AllProperties ........................................................................................................................... 241
Attributes ............................................................................................................................... 241
Caption .................................................................................................................................. 241
Controller ............................................................................................................................... 241
Extension ............................................................................................................................... 242
Icon ........................................................................................................................................ 242
Id ........................................................................................................................................... 242
Name ..................................................................................................................................... 242
Properties ............................................................................................................................... 242
State ....................................................................................................................................... 242
Version ................................................................................................................................... 243
IUserResult ................................................................................................................................... 243
CalculateTimeHistory .............................................................................................................. 243
HasImaginary ......................................................................................................................... 243
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxiii

ANSYS ACT Reference Guide


ResultAveraging ..................................................................................................................... 243
ResultLocation ........................................................................................................................ 244
ResultType .............................................................................................................................. 244
Suppressed ............................................................................................................................ 244
Unit ........................................................................................................................................ 244
IUserSolver ................................................................................................................................... 244
AnalysisType ........................................................................................................................... 244
PhysicsType ............................................................................................................................ 245
ObjectLocationEnum .................................................................................................................... 245
ObjectTypeEnum .......................................................................................................................... 245
PropertyDisplayEnum ................................................................................................................... 245
UpdateStateFreqEnum .................................................................................................................. 246
ValidStateEnum ............................................................................................................................ 246
Ansys.ACT.Interfaces.Post Namespace ............................................................................................. 247
IComponentInfo ........................................................................................................................... 247
Name ..................................................................................................................................... 247
QuantityName ........................................................................................................................ 248
Unit ........................................................................................................................................ 248
ICustomResultReader .................................................................................................................... 248
GetComponentNames(string) ................................................................................................. 248
GetComponentUnit(string, string) ........................................................................................... 249
GetResultLocation(string) ....................................................................................................... 249
GetResultNames() ................................................................................................................... 249
GetResultType(string) ............................................................................................................. 249
GetStepValues() ...................................................................................................................... 250
GetValues(string, IResultCollector) ........................................................................................... 250
SetCurrentStep(IStepInfo) ....................................................................................................... 250
IResult .......................................................................................................................................... 250
Components .......................................................................................................................... 251
Location ................................................................................................................................. 251
Name ..................................................................................................................................... 251
GetComponentInfo(string) ...................................................................................................... 251
GetElementValues(int) ............................................................................................................ 252
GetNodeValues(int) ................................................................................................................ 252
SelectComponents(IEnumerable<string>) ............................................................................... 252
IResultCollector ............................................................................................................................ 252
ComponentCount ................................................................................................................... 253
HasImaginary ......................................................................................................................... 253
Ids .......................................................................................................................................... 253
Indices .................................................................................................................................... 254
Lengths .................................................................................................................................. 254
ContainsId(int) ........................................................................................................................ 254
SetAllValues(double[]) ............................................................................................................. 254
SetAllValues(IEnumerable<double>) ....................................................................................... 254
SetImaginaryValues(int, double[]) ............................................................................................ 255
SetImaginaryValues(int, IEnumerable<double>) ...................................................................... 255
SetValues(int, double[]) ........................................................................................................... 255
SetValues(int, IEnumerable<double>) ...................................................................................... 256
IResultReader ............................................................................................................................... 256
CurrentResultSet .................................................................................................................... 256
CurrentTimeFreq .................................................................................................................... 256
HasImaginaryResults .............................................................................................................. 257

xxiv

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


ListTimeFreq ........................................................................................................................... 257
ResultNames .......................................................................................................................... 257
ResultSetCount ....................................................................................................................... 257
GetResult(string) ..................................................................................................................... 257
IStepInfo ....................................................................................................................................... 257
DefineBy ................................................................................................................................ 258
Set ......................................................................................................................................... 258
Time ....................................................................................................................................... 258
ResultAveragingEnum .................................................................................................................. 258
ResultLocationEnum ..................................................................................................................... 259
ResultTypeEnum ........................................................................................................................... 259
StepDefineByEnum ....................................................................................................................... 259
Ansys.ACT.Interfaces.Geometry Namespace .................................................................................... 261
GeoBodyTypeEnum ...................................................................................................................... 261
GeoCellTypeEnum ........................................................................................................................ 262
GeoCurveTypeEnum ..................................................................................................................... 262
GeoSurfaceTypeEnum .................................................................................................................. 263
IBaseGeoBody .............................................................................................................................. 263
Area ....................................................................................................................................... 264
BodyType ............................................................................................................................... 264
Centroid ................................................................................................................................. 264
Edges ..................................................................................................................................... 264
Faces ...................................................................................................................................... 264
Length ................................................................................................................................... 265
Vertices .................................................................................................................................. 265
Volume ................................................................................................................................... 265
IBaseGeoBodyOrPart .................................................................................................................... 265
IBaseGeoEdge .............................................................................................................................. 265
Bodies .................................................................................................................................... 266
Centroid ................................................................................................................................. 266
CurveType .............................................................................................................................. 266
EndVertex ............................................................................................................................... 266
Faces ...................................................................................................................................... 266
Length ................................................................................................................................... 266
StartVertex ............................................................................................................................. 267
Vertices .................................................................................................................................. 267
IBaseGeoEntity ............................................................................................................................. 267
Id ........................................................................................................................................... 267
Type ....................................................................................................................................... 267
GetBoundingBox() .................................................................................................................. 267
IBaseGeoFace ............................................................................................................................... 268
Area ....................................................................................................................................... 268
Bodies .................................................................................................................................... 268
Centroid ................................................................................................................................. 269
Edges ..................................................................................................................................... 269
SurfaceType ............................................................................................................................ 269
Vertices .................................................................................................................................. 269
NormalAtParam(double, double) ............................................................................................. 269
NormalsAtParams(double[]) .................................................................................................... 269
ParamAtPoint(double[]) .......................................................................................................... 270
PointAtParam(double, double) ................................................................................................ 270
PointsAtParams(double[]) ....................................................................................................... 270
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxv

ANSYS ACT Reference Guide


IBaseGeoPart ................................................................................................................................ 271
Bodies .................................................................................................................................... 271
Name ..................................................................................................................................... 271
IBaseGeoVertex ............................................................................................................................ 271
Bodies .................................................................................................................................... 272
Edges ..................................................................................................................................... 272
Faces ...................................................................................................................................... 272
X ............................................................................................................................................ 272
Y ............................................................................................................................................ 272
Z ............................................................................................................................................ 272
IGeoAssembly .............................................................................................................................. 272
Dimension .............................................................................................................................. 273
Name ..................................................................................................................................... 273
Parts ....................................................................................................................................... 273
Unit ........................................................................................................................................ 273
IGeoBody ..................................................................................................................................... 273
CrossSection ........................................................................................................................... 274
CrossSectionOffset ................................................................................................................. 274
CrossSectionOffsetType .......................................................................................................... 274
Material .................................................................................................................................. 274
Name ..................................................................................................................................... 275
Shells ..................................................................................................................................... 275
Suppressed ............................................................................................................................ 275
Thickness ............................................................................................................................... 275
IGeoData ...................................................................................................................................... 275
Assemblies ............................................................................................................................. 275
GeoEntityById(int) .................................................................................................................. 276
IGeoEdge ..................................................................................................................................... 276
CrossSectionOrientation ......................................................................................................... 276
Extents ................................................................................................................................... 277
IsParamReversed .................................................................................................................... 277
ParamAtPoint(double[]) .......................................................................................................... 277
PointAtParam(double) ............................................................................................................ 277
PointsAtParams(double[]) ....................................................................................................... 277
TangentAtParam(double) ........................................................................................................ 278
TangentsAtParams(double[]) ................................................................................................... 278
IGeoEntity .................................................................................................................................... 278
Part ........................................................................................................................................ 278
IGeoFace ...................................................................................................................................... 279
Loops ..................................................................................................................................... 279
Shell ....................................................................................................................................... 279
IGeoLoop ..................................................................................................................................... 279
Edges ..................................................................................................................................... 279
Face ....................................................................................................................................... 280
IGeoPart ....................................................................................................................................... 280
IGeoShell ...................................................................................................................................... 280
Faces ...................................................................................................................................... 280
IGeoTessellation ........................................................................................................................... 280
FacetCount ............................................................................................................................. 281
Indices .................................................................................................................................... 281
Normals .................................................................................................................................. 281
Points ..................................................................................................................................... 281

xxvi

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


IGeoVertex ................................................................................................................................... 281
MaterialTypeEnum ........................................................................................................................ 281
Ansys.ACT.Interfaces.UserInterface Namespace .............................................................................. 283
EntryTypeEnum ............................................................................................................................ 283
IEntry ........................................................................................................................................... 283
Caption .................................................................................................................................. 284
Checked ................................................................................................................................. 284
Enabled .................................................................................................................................. 284
Entries .................................................................................................................................... 284
EntryType ............................................................................................................................... 284
Visible .................................................................................................................................... 284
INamed ........................................................................................................................................ 285
Name ..................................................................................................................................... 285
INamedCollection<T> ................................................................................................................... 285
Item ....................................................................................................................................... 285
Names .................................................................................................................................... 285
IToolbar ........................................................................................................................................ 286
Caption .................................................................................................................................. 286
Entries .................................................................................................................................... 286
Visible .................................................................................................................................... 286
IUserInterface ............................................................................................................................... 286
IsBatchMode .......................................................................................................................... 287
Toolbars ................................................................................................................................. 287
GetExtensionToolbars(IExtension) ........................................................................................... 287
Ansys.ACT.Interfaces.Graphics Namespace ...................................................................................... 289
ICamera ........................................................................................................................................ 289
ZoomFactor ............................................................................................................................ 290
GetLocation() .......................................................................................................................... 290
GetTarget() ............................................................................................................................. 290
IDraw2DContext ........................................................................................................................... 290
Clear() .................................................................................................................................... 290
DrawText2D(IPoint, string) ....................................................................................................... 291
DrawText2D(int, int, string) ...................................................................................................... 291
LineTo2D(IPoint) ..................................................................................................................... 291
LineTo2D(int, int) .................................................................................................................... 291
MoveTo2D(IPoint) ................................................................................................................... 292
MoveTo2D(int, int) .................................................................................................................. 292
IDraw3DContext ........................................................................................................................... 292
Close() .................................................................................................................................... 293
DrawCircle(IEnumerable<double>, double, IEnumerable<double>) ......................................... 293
DrawDisc(IEnumerable<double>, double, IEnumerable<double>) ........................................... 294
DrawPoints(IEnumerable<double>) ........................................................................................ 294
DrawPoints(IEnumerable<double>, double) ............................................................................ 294
DrawPolygon(IEnumerable<double>, IEnumerable<double>) ................................................. 294
DrawPolyline(IEnumerable<double>, bool) ............................................................................. 295
DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ......................... 295
DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumerable<int>) .............................................................................................................................. 296
SetTransformation(double[]) ................................................................................................... 296
IDrawContext ............................................................................................................................... 296
Color ...................................................................................................................................... 297
DepthTest ............................................................................................................................... 297
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxvii

ANSYS ACT Reference Guide


LineWeight ............................................................................................................................. 297
Translucency .......................................................................................................................... 297
Visible .................................................................................................................................... 297
IFactory2D .................................................................................................................................... 297
CreatePolyline() ...................................................................................................................... 298
CreatePolyline(IEnumerable<IPoint>) ...................................................................................... 298
CreateText() ............................................................................................................................ 298
CreateText(IPoint, string) ......................................................................................................... 298
IFactory3D .................................................................................................................................... 299
CreateArrow(double) .............................................................................................................. 300
CreateArrow(double, double, double, double) .......................................................................... 300
CreateBox(double, double, double) .......................................................................................... 301
CreateCircle(double) ............................................................................................................... 301
CreateCone(double, double) ................................................................................................... 301
CreateCone(double, double, double) ....................................................................................... 301
CreateCylinder(double, double) ............................................................................................... 302
CreateDisc(double) ................................................................................................................. 302
CreateGeometry(IGeoEntity) ................................................................................................... 302
CreateMesh(IElement) ............................................................................................................ 303
CreateMesh(IEnumerable<IElement>) ..................................................................................... 303
CreateMesh(IMeshData) .......................................................................................................... 303
CreateMesh(IMeshRegion) ...................................................................................................... 303
CreateNodeBox(IEnumerable<INode>) ................................................................................... 304
CreateNodeBox(INode) ........................................................................................................... 304
CreateNodeBox(IEnumerable<INode>, double) ....................................................................... 304
CreateNodeBox(INode, double) ............................................................................................... 304
CreatePoint() .......................................................................................................................... 305
CreatePoint(IEnumerable<IWorldPoint>, double) .................................................................... 305
CreatePoint(IWorldPoint, double) ............................................................................................ 305
CreatePolyline() ...................................................................................................................... 306
CreatePolyline(IEnumerable<IWorldPoint>) ............................................................................. 306
CreateQuad(double, double) ................................................................................................... 306
CreateShell() ........................................................................................................................... 306
CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ....................... 306
CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumerable<int>) .............................................................................................................................. 307
CreateSphere(double) ............................................................................................................. 307
CreateTriad(double) ................................................................................................................ 307
IGraphics ...................................................................................................................................... 308
Camera ................................................................................................................................... 308
Scene ..................................................................................................................................... 308
Unit ........................................................................................................................................ 309
CreatePixelPoint(int, int) .......................................................................................................... 309
CreateVector3D(double, double, double) ................................................................................. 309
CreateWorldPoint(double, double, double) .............................................................................. 309
ForceResume() ........................................................................................................................ 310
Redraw() ................................................................................................................................. 310
Suspend() ............................................................................................................................... 310
IGraphicsCollection ....................................................................................................................... 310
Entities ................................................................................................................................... 311
Factory2D ............................................................................................................................... 311
Factory3D ............................................................................................................................... 311

xxviii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


Clear() .................................................................................................................................... 311
CreateChildCollection() ........................................................................................................... 311
Remove(IGraphicsCollection) .................................................................................................. 311
Remove(IGraphicsEntity) ......................................................................................................... 312
IPixelPoint .................................................................................................................................... 312
X ............................................................................................................................................ 312
Y ............................................................................................................................................ 312
Set(int, int) .............................................................................................................................. 313
IPoint ........................................................................................................................................... 313
Changed ................................................................................................................................ 313
Clone() ................................................................................................................................... 313
ToPixelPoint() .......................................................................................................................... 313
ToWorldPoint() ........................................................................................................................ 314
ISuspendController ....................................................................................................................... 314
Resume() ................................................................................................................................ 314
ITransformable ............................................................................................................................. 314
Transformation3D ................................................................................................................... 314
ITransformation3D ........................................................................................................................ 315
Item ....................................................................................................................................... 315
Scale ...................................................................................................................................... 315
Reset() .................................................................................................................................... 316
Rotate(IVector3D, double) ....................................................................................................... 316
Set(double[]) .......................................................................................................................... 316
Set(IWorldPoint) ..................................................................................................................... 316
Set(IWorldPoint, IVector3D) ..................................................................................................... 317
Set(IWorldPoint, IVector3D, IVector3D) ..................................................................................... 317
Set(IWorldPoint, IVector3D, IVector3D, IVector3D) ..................................................................... 317
ToArray() ................................................................................................................................. 318
Translate(IVector3D) ............................................................................................................... 318
Translate(double, double, double) ........................................................................................... 318
IVector3D ..................................................................................................................................... 318
X ............................................................................................................................................ 319
Y ............................................................................................................................................ 319
Z ............................................................................................................................................ 319
CrossProduct(IVector3D) ......................................................................................................... 319
GetNormal() ........................................................................................................................... 320
IsColinearTo(IVector3D) ........................................................................................................... 320
IsColinearTo(IVector3D, double) ............................................................................................... 320
Length() ................................................................................................................................. 320
Normalize() ............................................................................................................................. 321
SquareLength() ....................................................................................................................... 321
IWorldPoint .................................................................................................................................. 321
X ............................................................................................................................................ 321
Y ............................................................................................................................................ 321
Z ............................................................................................................................................ 321
Ansys.ACT.Interfaces.DataModel Namespace .................................................................................. 323
IDataModelObject ........................................................................................................................ 323
ObjectLocation ....................................................................................................................... 323
ObjectType ............................................................................................................................. 323
Parent .................................................................................................................................... 323
SupportedLocations ............................................................................................................... 324
Ansys.ACT.Interfaces.Wizard Namespace ........................................................................................ 325
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxix

ANSYS ACT Reference Guide


IStepUserInterface ........................................................................................................................ 325
ContentPanelSizes .................................................................................................................. 325
CustomPanelControl ............................................................................................................... 325
HtmlContent .......................................................................................................................... 326
HtmlContentFile ..................................................................................................................... 326
NotifyChange() ....................................................................................................................... 326
IWizard ......................................................................................................................................... 326
Author .................................................................................................................................... 326
CurrentStep ............................................................................................................................ 327
Description ............................................................................................................................. 327
ExtensionName ...................................................................................................................... 327
Filename ................................................................................................................................ 327
Folder ..................................................................................................................................... 327
Name ..................................................................................................................................... 327
Steps ...................................................................................................................................... 328
IWizardStep .................................................................................................................................. 328
ComponentName ................................................................................................................... 328
NextStep ................................................................................................................................ 328
PreviousStep .......................................................................................................................... 328
StepId .................................................................................................................................... 329
SystemName .......................................................................................................................... 329
UserInterface .......................................................................................................................... 329
Wizard .................................................................................................................................... 329
Ansys.ACT.Interfaces.Graphics.Entities Namespace ........................................................................ 331
IArrow3D ...................................................................................................................................... 331
Body ...................................................................................................................................... 332
BodyLength ............................................................................................................................ 332
BodyRadius ............................................................................................................................ 332
Head ...................................................................................................................................... 332
HeadLength ........................................................................................................................... 332
HeadRadius ............................................................................................................................ 332
Length ................................................................................................................................... 333
IBox3D ......................................................................................................................................... 333
X ............................................................................................................................................ 333
Y ............................................................................................................................................ 333
Z ............................................................................................................................................ 333
ICircle3D ....................................................................................................................................... 334
Radius .................................................................................................................................... 334
ICone3D ....................................................................................................................................... 334
BottomRadius ......................................................................................................................... 334
Closed .................................................................................................................................... 334
Length ................................................................................................................................... 335
Samples ................................................................................................................................. 335
TopRadius .............................................................................................................................. 335
IDisc3D ......................................................................................................................................... 335
Radius .................................................................................................................................... 335
IGeometry3D ................................................................................................................................ 335
DisplayEdge ........................................................................................................................... 336
DisplayFace ............................................................................................................................ 336
DisplayVertex ......................................................................................................................... 336
EdgeColor .............................................................................................................................. 336
FaceColor ............................................................................................................................... 337

xxx

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


VertexColor ............................................................................................................................ 337
VertexSize ............................................................................................................................... 337
IGraphicsEntity ............................................................................................................................. 337
Color ...................................................................................................................................... 337
DepthTest ............................................................................................................................... 338
Is2D ........................................................................................................................................ 338
Is3D ........................................................................................................................................ 338
LineWeight ............................................................................................................................. 338
Translucency .......................................................................................................................... 338
Visible .................................................................................................................................... 338
Delete() .................................................................................................................................. 339
IMesh3D ....................................................................................................................................... 339
INodeBox3D ................................................................................................................................. 339
Size ........................................................................................................................................ 339
IPoint3D ....................................................................................................................................... 339
Points ..................................................................................................................................... 340
Size ........................................................................................................................................ 340
IPolyline<T> ................................................................................................................................. 340
Closed .................................................................................................................................... 340
EndPoint ................................................................................................................................ 340
Length ................................................................................................................................... 341
Points ..................................................................................................................................... 341
StartPoint ............................................................................................................................... 341
IQuad3D ....................................................................................................................................... 341
X ............................................................................................................................................ 341
Y ............................................................................................................................................ 341
IShell3D ........................................................................................................................................ 342
Colors ..................................................................................................................................... 342
Connectivity ........................................................................................................................... 342
HasColors ............................................................................................................................... 342
Initialized ................................................................................................................................ 343
Normals .................................................................................................................................. 343
TriangleCount ......................................................................................................................... 343
Vertices .................................................................................................................................. 343
SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) .................... 343
SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumerable<int>) .............................................................................................................................. 344
ISphere3D .................................................................................................................................... 344
Radius .................................................................................................................................... 344
Samples ................................................................................................................................. 345
IText2D ......................................................................................................................................... 345
Origin ..................................................................................................................................... 345
Text ........................................................................................................................................ 345
ITriad3D ........................................................................................................................................ 345
Length ................................................................................................................................... 346
XArrow ................................................................................................................................... 346
YArrow ................................................................................................................................... 346
ZArrow ................................................................................................................................... 346
Ansys.ACT.Interfaces.Common Namespace ..................................................................................... 347
IAttributeCollection ...................................................................................................................... 347
Item ....................................................................................................................................... 348
Keys ....................................................................................................................................... 348
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxxi

ANSYS ACT Reference Guide


Contains(string) ...................................................................................................................... 348
GetStringValue(string) ............................................................................................................ 348
GetValue(string) ...................................................................................................................... 348
GetValue(string, object) ........................................................................................................... 349
Remove(string) ....................................................................................................................... 349
SetValue(string, object) ........................................................................................................... 349
IExtension .................................................................................................................................... 349
InstallDir ................................................................................................................................. 350
MinorVersion .......................................................................................................................... 350
Name ..................................................................................................................................... 350
UniqueId ................................................................................................................................ 350
Version ................................................................................................................................... 350
IExtensionManager ....................................................................................................................... 351
CurrentExtension .................................................................................................................... 351
Extensions .............................................................................................................................. 351
ILog .............................................................................................................................................. 351
ViewLog() ............................................................................................................................... 352
WriteError(string) .................................................................................................................... 352
WriteMessage(string) .............................................................................................................. 352
WriteWarning(string) .............................................................................................................. 352
IParameter .................................................................................................................................... 352
Key ......................................................................................................................................... 353
Name ..................................................................................................................................... 353
Value ...................................................................................................................................... 353
IParameterManager ...................................................................................................................... 353
ISelectionInfo ............................................................................................................................... 353
Id ........................................................................................................................................... 354
Ids .......................................................................................................................................... 354
Name ..................................................................................................................................... 354
SelectionType ......................................................................................................................... 354
ISelectionManager ........................................................................................................................ 354
CurrentSelection ..................................................................................................................... 355
AddSelection(ISelectionInfo) ................................................................................................... 355
ClearSelection() ...................................................................................................................... 355
CreateSelectionInfo(SelectionTypeEnum) ................................................................................ 355
NewSelection(ISelectionInfo) .................................................................................................. 356
ITools ........................................................................................................................................... 356
GetGeoDataFromFile(string) ................................................................................................... 356
GetMeshDataFromFile(string, string) ....................................................................................... 356
GetResultsDataFromFile(string) ............................................................................................... 357
SelectionTypeEnum ...................................................................................................................... 357
Ansys.ACT.Interfaces.Analysis Namespace ...................................................................................... 359
CoordinateSystemTypeEnum ........................................................................................................ 359
IAnalysis ....................................................................................................................................... 359
AnalysisType ........................................................................................................................... 361
Components .......................................................................................................................... 361
CoordinateSystems ................................................................................................................. 361
GeoData ................................................................................................................................. 361
Id ........................................................................................................................................... 361
LoadObjects ........................................................................................................................... 361
MeshData ............................................................................................................................... 362
Name ..................................................................................................................................... 362

xxxii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


PhysicsType ............................................................................................................................ 362
PropertyNames ....................................................................................................................... 362
ResultObjects ......................................................................................................................... 362
Solver ..................................................................................................................................... 362
SolverName ............................................................................................................................ 362
StepsEndTime ........................................................................................................................ 363
UserObjects ............................................................................................................................ 363
WorkingDir ............................................................................................................................. 363
ComponentById(int) ............................................................................................................... 363
CoordinateSystemById(int) ..................................................................................................... 363
CreateLoadObject(string) ........................................................................................................ 364
CreatePostObject(string) ......................................................................................................... 364
CreateResultObject(string) ...................................................................................................... 364
CurrentConsistentUnitFromQuantityName(string) ................................................................... 364
GenerateMesh() ...................................................................................................................... 365
GetResultsData() ..................................................................................................................... 365
PropertyValue(string) .............................................................................................................. 365
PropertyValue(string, object) ................................................................................................... 365
Solve(bool) ............................................................................................................................. 365
WriteInputFile(string) .............................................................................................................. 366
ICoordinateSystem ....................................................................................................................... 366
CoordinateSystemType ........................................................................................................... 366
Id ........................................................................................................................................... 367
Matrix ..................................................................................................................................... 367
Name ..................................................................................................................................... 367
Origin ..................................................................................................................................... 367
XAxis ...................................................................................................................................... 367
YAxis ...................................................................................................................................... 367
ZAxis ...................................................................................................................................... 367
IDataObject .................................................................................................................................. 368
Id ........................................................................................................................................... 368
Name ..................................................................................................................................... 368
PropertyNames ....................................................................................................................... 368
Type ....................................................................................................................................... 368
PropertyValue(string) .............................................................................................................. 369
PropertyValue(string, object) ................................................................................................... 369
IDataObjectCollection ................................................................................................................... 369
Ids .......................................................................................................................................... 370
List ......................................................................................................................................... 370
Names .................................................................................................................................... 370
GetById(int) ............................................................................................................................ 370
GetByName(string) ................................................................................................................. 370
GetEnumerator() ..................................................................................................................... 371
NamesByType(string) .............................................................................................................. 371
IDataObjectContainer ................................................................................................................... 371
DataObjects ........................................................................................................................... 371
ISolverData ................................................................................................................................... 371
CurrentStep ............................................................................................................................ 372
MaxElementId ........................................................................................................................ 372
MaxElementType .................................................................................................................... 372
MaxNodeId ............................................................................................................................. 372
SolveType ............................................................................................................................... 373
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxxiii

ANSYS ACT Reference Guide


GetContactId(int) .................................................................................................................... 373
GetContactTargetId(int) .......................................................................................................... 373
GetCoordinateSystemSolverId(int) .......................................................................................... 373
GetMaterialSolverId(int) .......................................................................................................... 374
GetNewElementId() ................................................................................................................ 374
GetNewElementType() ............................................................................................................ 374
GetNewNodeId() ..................................................................................................................... 374
GetRemotePointNodeId(int) .................................................................................................... 374
SolveTypeEnum ............................................................................................................................ 375
Ansys.ACT.Math Namespace ............................................................................................................. 377
Matrix4D ...................................................................................................................................... 377
Matrix4D() .............................................................................................................................. 378
Matrix4D(double[]) ................................................................................................................. 378
Matrix4D(Matrix4D) ................................................................................................................ 378
Identity .................................................................................................................................. 379
Determinant ........................................................................................................................... 379
Item ....................................................................................................................................... 379
Item ....................................................................................................................................... 379
Add(Matrix4D) ........................................................................................................................ 379
CreateMirror(Vector3D, double) .............................................................................................. 380
CreateRotate(Vector3D, double) .............................................................................................. 380
CreateScale(double, double, double) ....................................................................................... 380
CreateSystem(Vector3D, Vector3D, Vector3D) ........................................................................... 381
CreateTranslate(double, double, double) ................................................................................. 381
Invert() ................................................................................................................................... 381
Multiply(Matrix4D) .................................................................................................................. 381
Scale(double, double, double) ................................................................................................. 382
Subtract(Matrix4D) ................................................................................................................. 382
ToString() ............................................................................................................................... 382
Transform(Vector3D) .............................................................................................................. 382
Translate(double, double, double) ........................................................................................... 383
Transpose() ............................................................................................................................. 383
op_Addition(Matrix4D, Matrix4D) ............................................................................................ 383
op_Explicit(Matrix4D) ............................................................................................................. 384
op_Multiply(Matrix4D, Matrix4D) ............................................................................................. 384
op_Subtraction(Matrix4D, Matrix4D) ....................................................................................... 384
Vector3D ...................................................................................................................................... 384
Vector3D(double[]) ................................................................................................................. 386
Vector3D(Vector3D) ................................................................................................................ 386
Vector3D(double, double, double) ........................................................................................... 386
I ............................................................................................................................................. 387
IJK .......................................................................................................................................... 387
J ............................................................................................................................................. 387
K ............................................................................................................................................ 387
X ............................................................................................................................................ 387
Y ............................................................................................................................................ 387
Z ............................................................................................................................................ 387
Zero ....................................................................................................................................... 388
Item ....................................................................................................................................... 388
Magnitude ............................................................................................................................. 388
MagnitudeSquared ................................................................................................................. 388
Add(Vector3D) ........................................................................................................................ 388

xxxiv

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


CloneNormalized() .................................................................................................................. 388
Cross(Vector3D, Vector3D) ...................................................................................................... 389
CrossProduct(Vector3D) .......................................................................................................... 389
Dot(Vector3D, Vector3D) ......................................................................................................... 389
DotProduct(Vector3D) ............................................................................................................ 389
Equals(object) ......................................................................................................................... 390
GetDistance(Vector3D, Vector3D) ............................................................................................ 390
GetDistanceSquared(Vector3D, Vector3D) ............................................................................... 390
GetHashCode() ....................................................................................................................... 391
Normalize() ............................................................................................................................. 391
Subtract(Vector3D) ................................................................................................................. 391
ToString() ............................................................................................................................... 391
op_Addition(Vector3D, Vector3D) ........................................................................................... 391
op_Division(Vector3D, double) ................................................................................................ 392
op_Equality(Vector3D, Vector3D) ............................................................................................ 392
op_Explicit(Vector3D) ............................................................................................................. 392
op_Inequality(Vector3D, Vector3D) ......................................................................................... 392
op_Multiply(double, Vector3D) ................................................................................................ 393
op_Multiply(Vector3D, double) ............................................................................................... 393
op_Multiply(Vector3D, Vector3D) ............................................................................................ 393
op_Subtraction(Vector3D, Vector3D) ....................................................................................... 394
op_UnaryNegation(Vector3D) ................................................................................................. 394
Ansys.ACT.Interfaces.Mesh Namespace ........................................................................................... 395
ElementTypeEnum ....................................................................................................................... 395
IElement ....................................................................................................................................... 396
Area ....................................................................................................................................... 396
Centroid ................................................................................................................................. 396
CornerNodeCount .................................................................................................................. 397
CornerNodeIds ....................................................................................................................... 397
CornerNodes .......................................................................................................................... 397
Dimension .............................................................................................................................. 397
Id ........................................................................................................................................... 397
NodeIds .................................................................................................................................. 397
Nodes ..................................................................................................................................... 398
Type ....................................................................................................................................... 398
Volume ................................................................................................................................... 398
IMeshData .................................................................................................................................... 398
ElementCount ........................................................................................................................ 399
ElementIds ............................................................................................................................. 399
Elements ................................................................................................................................ 399
NodeCount ............................................................................................................................. 399
NodeIds .................................................................................................................................. 399
Nodes ..................................................................................................................................... 399
Unit ........................................................................................................................................ 400
UseCache ............................................................................................................................... 400
ElementById(int) ..................................................................................................................... 400
ElementIdsFromNodeIds(IEnumerable<int>) ........................................................................... 400
MeshRegionById(int) .............................................................................................................. 400
NodeById(int) ......................................................................................................................... 401
NodeIdsFromElementIds(IEnumerable<int>) ........................................................................... 401
IMeshRegion ................................................................................................................................ 401
ElementCount ........................................................................................................................ 402
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxxv

ANSYS ACT Reference Guide


ElementIds ............................................................................................................................. 402
Elements ................................................................................................................................ 402
NodeCount ............................................................................................................................. 402
NodeIds .................................................................................................................................. 402
Nodes ..................................................................................................................................... 402
INode ........................................................................................................................................... 402
BodyIds .................................................................................................................................. 403
ConnectedElementIds ............................................................................................................ 403
ConnectedElements ............................................................................................................... 403
GeoEntityIds ........................................................................................................................... 403
Id ........................................................................................................................................... 404
X ............................................................................................................................................ 404
Y ............................................................................................................................................ 404
Z ............................................................................................................................................ 404
Ansys.DesignXplorer.API.Common Namespace ............................................................................... 405
enumDistributionType .................................................................................................................. 405
enumParameterRelationshipType ................................................................................................. 405
enumPointState ............................................................................................................................ 405
enumSimulationType .................................................................................................................... 406
IMethod ....................................................................................................................................... 406
AddDoubleListVariable(string, IListCpp, double) ....................................................................... 406
AddDoubleVariable(string, double, double, double) ................................................................. 407
AddIntegerListVariable(string, IListCpp, int) .............................................................................. 407
AddOutput(string) .................................................................................................................. 408
AddParameterRelationship(string, string, string, enumParameterRelationshipType) .................. 408
CanRun(out String) ................................................................................................................. 408
get_Setting(string) ................................................................................................................. 409
put_Setting(string, object) ...................................................................................................... 409
Run() ...................................................................................................................................... 409
IPoint ........................................................................................................................................... 409
ID ........................................................................................................................................... 410
State ....................................................................................................................................... 410
StateMessage ......................................................................................................................... 410
get_Value(string) .................................................................................................................... 410
put_Value(string, object) ......................................................................................................... 410
IServices ....................................................................................................................................... 411
ExistingPoints ......................................................................................................................... 412
Stopped ................................................................................................................................. 412
CalculateParameterRelationshipsFromPoint(IPoint) ................................................................. 412
CalculateParameterRelationshipsFromPoints(IListCpp) ............................................................ 412
CalculatePoint(IPoint) ............................................................................................................. 413
CalculatePoints(IListCpp) ........................................................................................................ 413
PublishLogMessage(string) ..................................................................................................... 413
PublishProgress(string, int) ...................................................................................................... 413
IUserExtensionOptimizationCriterion ............................................................................................ 414
IUserExtensionParameter .............................................................................................................. 414
Ansys.DesignXplorer.API.Sampling Namespace .............................................................................. 415
IUserSampling .............................................................................................................................. 415
LogFile ................................................................................................................................... 416
MaximumNumberOfDoubleListParameters ............................................................................. 416
MaximumNumberOfDoubleParameters .................................................................................. 416
MaximumNumberOfInputParameters ..................................................................................... 416

xxxvi

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


MaximumNumberOfIntegerListParameters ............................................................................. 417
NumberOfDoubleListParametersDefined ................................................................................ 417
NumberOfDoubleParametersDefined ..................................................................................... 417
NumberOfInputParametersDefined ........................................................................................ 417
NumberOfIntegerListParametersDefined ................................................................................ 417
Ansys.DesignXplorer.API.Optimization Namespace ........................................................................ 419
DXConvergenceData ..................................................................................................................... 420
DXConvergenceDescription .......................................................................................................... 420
DXOptimizationPoint .................................................................................................................... 420
enumConstraintHandlingType ...................................................................................................... 420
enumConstraintType .................................................................................................................... 420
enumCurveType ........................................................................................................................... 420
enumGoalType ............................................................................................................................. 420
enumPostProcessingType ............................................................................................................. 421
IConvergenceData ........................................................................................................................ 421
get_Value(int, out Int32, out Double, out Boolean) ................................................................... 421
put_Value(int, int, double, bool) ............................................................................................... 422
IConvergenceDescription .............................................................................................................. 422
IndexOfCurvesSupportingFeasibility ....................................................................................... 423
NumberOfFeasibleCurves ....................................................................................................... 423
NumberOfGroups ................................................................................................................... 423
Quantity ................................................................................................................................. 423
Unit ........................................................................................................................................ 423
XAxisLabel .............................................................................................................................. 423
YAxisLabel .............................................................................................................................. 423
AddCurve(int, string, enumCurveType, bool) ............................................................................ 424
AddGroup(string) ................................................................................................................... 424
get_CurveLabel(int) ................................................................................................................ 424
get_CurveType(int) ................................................................................................................. 425
get_GroupLabel(int) ............................................................................................................... 425
get_NumberOfCurves(int) ....................................................................................................... 425
IOptimizationMethod ................................................................................................................... 425
Candidates ............................................................................................................................. 426
PostProcessingTypes ............................................................................................................... 426
Samples ................................................................................................................................. 427
Services .................................................................................................................................. 427
AddConstraint(string, enumConstraintType, object, object, double, bool) .................................. 427
AddCustomConstraintProperty(string, string, object) ............................................................... 427
AddCustomObjectiveProperty(string, string, object) ................................................................ 428
AddCustomVariableProperty(string, string, object) ................................................................... 428
AddDoubleListVariable(string, IListCpp, double) ....................................................................... 429
AddDoubleVariable(string, double, double, double) ................................................................. 429
AddIntegerListVariable(string, IListCpp, int) .............................................................................. 429
AddObjective(string, enumGoalType, double, double) .............................................................. 430
AddOutput(string) .................................................................................................................. 430
AddParameterRelationship(string, string, string, enumParameterRelationshipType) .................. 431
CanRun(out String) ................................................................................................................. 431
get_Setting(string) ................................................................................................................. 431
put_Setting(string, object) ...................................................................................................... 431
Run() ...................................................................................................................................... 432
IOptimizationPoint ....................................................................................................................... 432
Feasible .................................................................................................................................. 432
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxxvii

ANSYS ACT Reference Guide


ID ........................................................................................................................................... 433
ParetoFrontIndex .................................................................................................................... 433
State ....................................................................................................................................... 433
StateMessage ......................................................................................................................... 433
get_Value(string) .................................................................................................................... 433
put_Value(string, object) ......................................................................................................... 433
IOptimizationServices ................................................................................................................... 434
ExistingPoints ......................................................................................................................... 435
Stopped ................................................................................................................................. 435
CalculateParameterRelationshipsFromPoint(IPoint) ................................................................. 435
CalculateParameterRelationshipsFromPoints(IListCpp) ............................................................ 436
CalculatePoint(IPoint) ............................................................................................................. 436
CalculatePoints(IListCpp) ........................................................................................................ 436
PublishLogMessage(string) ..................................................................................................... 436
PublishProgress(string, int) ...................................................................................................... 437
PushConvergenceData(IConvergenceData) ............................................................................. 437
PushHistoryPoint(IOptimizationPoint) ..................................................................................... 437
PushHistoryPoints(IListCpp) .................................................................................................... 437
IUserOptimizer ............................................................................................................................. 438
BasedOnDirectOptimizationOnly ............................................................................................ 441
BasedOnResponseSurfaceOnly ............................................................................................... 441
ConstraintHandling ................................................................................................................ 441
ConstraintImportance ............................................................................................................. 441
ConstraintOnInputParameter .................................................................................................. 441
ConvergenceData ................................................................................................................... 442
EqualToConstraint .................................................................................................................. 442
EqualToConstraintDefined ...................................................................................................... 442
GreaterThanConstraint ........................................................................................................... 442
GreaterThanConstraintDefined ............................................................................................... 442
HistoryChartXAxisType ........................................................................................................... 442
InsideBoundsConstraint .......................................................................................................... 443
InsideBoundsConstraintDefined .............................................................................................. 443
IsDirectOptimization ............................................................................................................... 443
LessThanConstraint ................................................................................................................ 443
LessThanConstraintDefined .................................................................................................... 443
LogFile ................................................................................................................................... 443
MaximizeObjective ................................................................................................................. 444
MaximizeObjectiveDefined ..................................................................................................... 444
MaximumNumberOfConstraints ............................................................................................. 444
MaximumNumberOfDoubleListParameters ............................................................................. 444
MaximumNumberOfDoubleParameters .................................................................................. 444
MaximumNumberOfInputParameters ..................................................................................... 444
MaximumNumberOfIntegerListParameters ............................................................................. 445
MaximumNumberOfObjectives .............................................................................................. 445
MinimizeObjective .................................................................................................................. 445
MinimizeObjectiveDefined ..................................................................................................... 445
MinimumNumberOfConstraints .............................................................................................. 445
MinimumNumberOfObjectives ............................................................................................... 445
NumberOfConstraintsDefined ................................................................................................. 446
NumberOfConstraintsDefinedOnInputs .................................................................................. 446
NumberOfDoubleListParametersDefined ................................................................................ 446
NumberOfDoubleParametersDefined ..................................................................................... 446

xxxviii

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ANSYS ACT Reference Guide


NumberOfInputParametersDefined ........................................................................................ 446
NumberOfIntegerListParametersDefined ................................................................................ 446
NumberOfObjectivesDefined .................................................................................................. 446
NumberOfObjectivesDefinedOnInputs ................................................................................... 447
ObjectiveImportance .............................................................................................................. 447
ObjectiveOnInputParameter ................................................................................................... 447
ParameterRelationship ............................................................................................................ 447
SeekObjective ........................................................................................................................ 447
SeekObjectiveDefined ............................................................................................................ 447
StartingPointRequired ............................................................................................................ 448
Ansys.DesignXplorer.API Namespace .............................................................................................. 449
ParameterNature .......................................................................................................................... 449

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxxix

xl

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Part I: Namespaces

Ansys.AAP.Core Namespace
Declaration Syntax
namespace Ansys.AAP.Core
Table 1: Members
ExtensionId Provides service to uniquely identify the
extension.

ExtensionId
Provides service to uniquely identify the extension.

Declaration Syntax
public class ExtensionId
Table 2: Members
Property UniqueId Get the unique id of the
extension.

UniqueId
Get the unique id of the extension.

Declaration Syntax
public string UniqueId { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.AAP.Core.Utilities Namespace
Declaration Syntax
namespace Ansys.AAP.Core.Utilities
Table 3: Members
AttributeCollection

A collection of attributes.

NamedCollection<T> 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 4: Members
Property Item

Get or set an attribute value.

Property Keys

The list of the available keys in the collection.

Method Clone()

Create a clone of the currection collection.

Method Contains(string)

Check if the collection contains an attribute.

Method GetStringValue(string)

Gets an attribute value by its name.

Method GetValue(string)

Gets an attribute value by its name.

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


Method Remove(string)

Remove an attribute. The attribute cannot be removed if it was


declared as static attribute.

Method SetValue(string, object)

Set an attribute value.

Item
Get or set an attribute value.

Declaration Syntax
public object Item { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.AAP.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 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

NamedCollection<T>

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.

NamedCollection<T>
Represents a collection of INamed objects that could be found by its Name field.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.AAP.Core.Utilities Namespace

Declaration Syntax
public class NamedCollection<T> : ReadOnlyCollection<T>, INamedCollection<T>
Table 5: Members
Property Item

The operator [] can find an object by its name.

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

Item
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 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Mechanical
Table 6: Members
IMechanicalDataModel Defines the data model of the Mechanical
application.
IMechanicalExtAPI

Exposes the main entry point of all ATC APIs.

IMechanicalUserLoad

Defines a Mechanical user load.

IMechanicalUserObject Defines a Mechanical user object.


IMechanicalUserResult

Defines a Mechanical user result.

IMechanicalUserSolver

Defines a Mechanical user solver.

MechanicalPanelEnum

Specifies the panel type.

IMechanicalDataModel
Defines the data model of the Mechanical application.

Declaration Syntax
public interface IMechanicalDataModel
Table 7: Members
Property Project

Gets the project object. Main object of the tree of


Mechanical.

Method CurrentUnitFromQuantityName(string) Returns the current unit from a quantity name.


Method GetObjectById(int)

Returns the Mechanical object related to the


provided Id.

Project
Gets the project object. Main object of the tree of Mechanical.

Declaration Syntax
public Project Project { get; }

CurrentUnitFromQuantityName(string)
Returns the current unit from a quantity name.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Mechanical Namespace

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.

Declaration Syntax
public DataModelObject GetObjectById(int id)

Parameters
id(int)
The id of the object.

IMechanicalExtAPI
Exposes the main entry point of all ATC APIs.

Declaration Syntax
public interface IMechanicalExtAPI
Table 8: Members
Method LockPrePostLicense()

Locks the license used by the PRE/POST application.

Method UnlockPrePostLicense() 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()
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.

10

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MechanicalPanelEnum

Declaration Syntax
public void UnlockPrePostLicense()

IMechanicalUserLoad
Defines a Mechanical user load.

Declaration Syntax
public interface IMechanicalUserLoad

IMechanicalUserObject
Defines a Mechanical user object.

Declaration Syntax
public interface IMechanicalUserObject
Table 9: Members
Property Analysis 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

MechanicalPanelEnum
Specifies the panel type.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

11

Ansys.ACT.Interfaces.Mechanical Namespace

Declaration Syntax
public enum MechanicalPanelEnum
Table 10: 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.

12

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.DesignModeler
Table 11: Members
IDesignModelerDataModel

Defines the DesignModeler data model.

IDesignModelerExtAPI

Defines the main entry point of all APIs.

IDesignModelerGeoData

Defines the DesignModeler geometry data model.

IDesignModelerGeoFeature

Defines a DesignModeler custom feature.

IDesignModelerSelectionInfo Defines the DesignModeler selection information.


IExtrude

Defines an "Extrude" operation.

IGeometryBuilder

Defines the geometry builder.

IIntersect

Defines an "Intersect" operation.

IOperations

Defines a list of available geometry operations.

IOperationTools

Defines a list of tools to manipulate the geometry.

IPrimitives

Defines the list of creatable primitives.

IPSGeoBody

Defines a body.

IPSGeoEdge

Defines an edge.

IPSGeoEntity

Defines a generic geometry entity.

IPSGeoFace

Defines a face.

IPSGeoPart

Defines a part.

IQueries

Defines a list of available queries on the geometry.

IRevolve

Defines a "Revolve" operation.

ISheetCone

Defines a sheet cone primitive.

ISheetCylinder

Defines a sheet cylinder primitive.

ISheetPolygon

Defines a sheet polygon primitive.

ISheets

Defines the list all creatable sheet geometry


primitives.

ISheetSphere

Defines a sheet sphere primitive.

ISolidBox

Defines a solid box primitive.

ISolidCone

Defines a solid cone primitive.

ISolidCylinder

Defines a solid cylinder primitive.

ISolids

Defines the list of all creatable solid geometry


primitives.

ISolidSphere

Defines a solid sphere primitive.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

13

Ansys.ACT.Interfaces.DesignModeler Namespace
ISubtract

Defines a "Subtract" operation.

IUnion

Defines an "Union" operation.

IWireArc

Defines a wire arc primitive.

IWireBCurve

Defines awire b-curve primitive.

IWireEllipse

Defines a wire ellipse primitive.

IWirePolyline

Defines a wire polyline primitive.

IWires

Defines the list of all creatable wire geometry


primitives.

IDesignModelerDataModel
Defines the DesignModeler data model.

Declaration Syntax
public interface IDesignModelerDataModel
Table 12: Members
Property Components

Gets all components (named selections).

Property GeoData

Gets the geometry data model object.

Property GeometryBuilder

Gets the geometry builder object.

Property Queries

Gets the queries object.

Method ComponentById(int)

Returns the component (named selection) associated


to the specified identifier.

Method CurrentUnitFromQuantityName(string) 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; }

GeometryBuilder
Gets the geometry builder object.

14

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IDesignModelerGeoData

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

IDesignModelerGeoData
Defines the DesignModeler geometry data model.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

15

Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IDesignModelerGeoData
Table 13: Members
Property Bodies Gets all
bodies.
Property Parts

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 14: Members
Property Bodies

Gets or sets the list of bodies or


parts generated by the feature.

Property MaterialType

Gets or sets the material type used


to generate the feature.

Method AddProblematicGeometry(IEnumerable<IPSGeoEntity>, Add a list of geometry entities has


string)
problemetic geometries.

Bodies
Gets or sets the list of bodies or parts generated by the feature.

Declaration Syntax
public IEnumerable<IBaseGeoBodyOrPart> Bodies { set;get; }

16

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IDesignModelerSelectionInfo

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 15: Members
Property Entities

Gets the list of selected geoemtry entities.

Property Locations Gets the location point for each selected


entities.

Entities
Gets the list of selected geoemtry entities.

Declaration Syntax
public IList<IBaseGeoEntity> Entities { get; }

Locations
Gets the location point for each selected entities.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

17

Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public IList<double[]> Locations { set;get; }

IExtrude
Defines an "Extrude" operation.

Declaration Syntax
public interface IExtrude
Table 16: Members
Property Depth

Gets or Sets the depth of the extrusion.

Property Direction

Gets or Sets the direction of the extrusion.

Property Walled

Gets or Sets the walled flag.

Method ApplyTo(IPSGeoEntity) 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.

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)

18

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IIntersect

Parameters
profile(IPSGeoEntity)
The profile.

IGeometryBuilder
Defines the geometry builder.

Declaration Syntax
public interface IGeometryBuilder
Table 17: Members
Property Operations Gets the list of creatable
operations.
Property Primitives

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; }

IIntersect
Defines an "Intersect" operation.

Declaration Syntax
public interface IIntersect
Table 18: Members
Method ApplyTo(IEnumerable<IPSGeoBody>) 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 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

19

Ansys.ACT.Interfaces.DesignModeler Namespace

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 19: Members
Property Queries

Gets the list of methods to query


information on the geometry.

Property Tools

Gets the list of additional tools to


manipulate the geometry.

Method CreateExtrudeOperation(IEnumerable<double>,
double)

Creates an "Extrude" operation.

Method CreateIntersectOperation(IEnumerable<IPSGeoBody>) Creates an "Intersect" operation.


Method CreateRevolveOperation(IEnumerable<double>,
IEnumerable<double>)

Creates a "Revolve" operation.

Method CreateSubtractOperation(IEnumerable<IPSGeoBody>) Creates a "Subtract" operation.


Method CreateUnionOperation()

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.

20

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOperations

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.

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.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

21

Ansys.ACT.Interfaces.DesignModeler Namespace

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 20: Members
Method CopyBody(IPSGeoBody)

Copies a body.

Method CreatePart(IEnumerable<IPSGeoBody>)

Creates a new part (group of bodies).

Method DeleteBody(IPSGeoBody)

Deletes a body.

Method EdgesToWireBody(IEnumerable<IPSGeoEdge>) Transforms a set of edges into a wire body.


Method FacesToSheetBody(IEnumerable<IPSGeoFace>) Transforms a set of faces to a sheet body.
Method Imprint(IPSGeoBody,
IEnumerable<IPSGeoBody>)

Imprints a list of bodies to a target body.

Method OffsetFace(IEnumerable<IPSGeoFace>,
double)

Does a normal offset of faces with a given


offset value.

Method SheetBodyToSolidBody(IPSGeoBody)

Transforms a sheet body to a solid body.

Method SimplifyTopology(IPSGeoEntity)

Simplifies the topology of the given entity.

Method ThickenBody(IPSGeoBody,
IEnumerable<IPSGeoFace>, double, double)

Does a thicken operation on a body and


remove some faces.

Method TransformBody(IPSGeoBody, Matrix4D)

Transform a body.

Method WireToSheetBody(IPSGeoBody)

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.

22

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOperationTools

CreatePart(IEnumerable<IPSGeoBody>)
Creates a new part (group of bodies).

Declaration Syntax
public IPSGeoPart CreatePart(IEnumerable<IPSGeoBody> bodies)

Parameters
bodies(IEnumerable<IPSGeoBody>)
The list of bodies to group.

DeleteBody(IPSGeoBody)
Deletes a body.

Declaration Syntax
public void DeleteBody(IPSGeoBody body)

Parameters
body(IPSGeoBody)
The body to delete.

EdgesToWireBody(IEnumerable<IPSGeoEdge>)
Transforms a set of edges into a wire body.

Declaration Syntax
public IPSGeoBody EdgesToWireBody(IEnumerable<IPSGeoEdge> edges)

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.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

23

Ansys.ACT.Interfaces.DesignModeler Namespace

Imprint(IPSGeoBody, IEnumerable<IPSGeoBody>)
Imprints a list of bodies to a target body.

Declaration Syntax
public void Imprint(IPSGeoBody target, IEnumerable<IPSGeoBody> tools)

Parameters
target(IPSGeoBody)
The body on which imprint will be added.
tools(IEnumerable<IPSGeoBody>)
List of bodies to imprint.

OffsetFace(IEnumerable<IPSGeoFace>, double)
Does a normal offset of faces with a given offset value.

Declaration Syntax
public IPSGeoBody OffsetFace(IEnumerable<IPSGeoFace> faces, double offset)

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)

24

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOperationTools

Parameters
entity(IPSGeoEntity)
Entity to simplify.

ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, double, double)


Does a thicken operation on a body and remove some faces.

Declaration Syntax
public IPSGeoBody ThickenBody(IPSGeoBody body, IEnumerable<IPSGeoFace> facesToRemove, double
thick1, double thick2)

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)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

25

Ansys.ACT.Interfaces.DesignModeler Namespace

Parameters
wire(IPSGeoBody)
The wire body to transform.

IPrimitives
Defines the list of creatable primitives.

Declaration Syntax
public interface IPrimitives
Table 21: Members
Property Sheet Gets the list of all creatable sheet geometry
primitives.
Property Solid

Gets the list of all creatable solid geometry


primitives.

Property Wire

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.

26

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IQueries

Declaration Syntax
public interface IPSGeoBody

IPSGeoEdge
Defines an edge.

Declaration Syntax
public interface IPSGeoEdge

IPSGeoEntity
Defines a generic geometry entity.

Declaration Syntax
public interface IPSGeoEntity

IPSGeoFace
Defines a face.

Declaration Syntax
public interface IPSGeoFace

IPSGeoPart
Defines a part.

Declaration Syntax
public interface IPSGeoPart

IQueries
Defines a list of available queries on the geometry.

Declaration Syntax
public interface IQueries
Table 22: Members
Method Clash(IEnumerable<IPSGeoEntity>,
IEnumerable<IPSGeoEntity>)

Detects clash between 2 sets of geometry


entities.

Method Coincidence(IPSGeoEntity, IPSGeoEntity)

Checks if 2 geometry entities are


coincident.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

27

Ansys.ACT.Interfaces.DesignModeler Namespace
Method Containment(IPSGeoEntity, IPSGeoEntity)

Checks if one geometry entity contains


one other.

Method Distance(IEnumerable<IPSGeoEntity>,
IEnumerable<IPSGeoEntity>)

Computes the distance between 2 sets 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.
smallOne(IPSGeoEntity)
The target geometry entity.

28

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IRevolve

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 23: Members
Property Angle

Gets or sets the angle of the revolution.

Property Axis

Gets or sets the axis of the revolution (x, y, z).

Property Origin

Gets or sets the origin of the revolution (x, y, z).

Property Walled

Gets or sets the walled flag.

Method ApplyTo(IPSGeoEntity) Applies the operation to a profile given in


argument.

Angle
Gets or sets the angle of the revolution.

Declaration Syntax
public double Angle { set;get; }

Axis
Gets or sets the axis of the revolution (x, y, z).

Declaration Syntax
public IEnumerable<double> Axis { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

29

Ansys.ACT.Interfaces.DesignModeler Namespace

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 24: Members
Property Center

Gets or sets the center of the cone (x, y,


z).

Property Direction Gets or sets the direction of the cone (x,


y, z).
Property Radius1

Gets or sets the top radius of the cone.

Property Radius2

Gets or sets the bottom radius of the


cone.

Center
Gets or sets the center of the cone (x, y, z).

30

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISheetCylinder

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 25: Members
Property Center

Gets or sets the center of the


cylinder.

Property Direction Gets or sets the axis of the


cylinder.
Property Radius

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; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

31

Ansys.ACT.Interfaces.DesignModeler Namespace

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 26: Members
Property Points Gets or sets the list of points (x1, y1, z1, x2, y2,
z2, ...)

Points
Gets or sets the list of points (x1, y1, z1, x2, y2, z2, ...)

Declaration Syntax
public IEnumerable<double> Points { set;get; }

ISheets
Defines the list all creatable sheet geometry primitives.

Declaration Syntax
public interface ISheets
Table 27: Members
Method CreateCylinder(IEnumerable<double>,
IEnumerable<double>, double)

Creates a sheet cylinder primitive


generator.

Method CreatePolygon(IEnumerable<double>)

Creates a sheet polygon primitive


generator.

32

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISheetSphere

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.

ISheetSphere
Defines a sheet sphere primitive.

Declaration Syntax
public interface ISheetSphere
Table 28: Members
Property Center Gets or sets the center of the
sphere.
Property Radius Gets or sets the radius of the
sphere.

Center
Gets or sets the center of the sphere.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

33

Ansys.ACT.Interfaces.DesignModeler Namespace

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 29: Members
Property Point1 Gets or sets the first point of the box (x, y,
z).
Property Point2 Gets or sets the second point of the box (x,
y, z).

Point1
Gets or sets the first point of the box (x, y, z).

Declaration Syntax
public IEnumerable<double> Point1 { set;get; }

Point2
Gets or sets the second point of the box (x, y, z).

Declaration Syntax
public IEnumerable<double> Point2 { set;get; }

ISolidCone
Defines a solid cone primitive.

34

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISolidCylinder

Declaration Syntax
public interface ISolidCone
Table 30: Members
Property Center

Gets or sets the center of the cone (x, y,


z).

Property Direction Gets or sets the direction of the cone (x,


y, z).
Property Radius1

Gets or sets the top radius of the cone.

Property Radius2

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; }

ISolidCylinder
Defines a solid cylinder primitive.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

35

Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface ISolidCylinder
Table 31: Members
Property Center

Gets or sets the center of the cylinder (x, y,


z).

Property Direction Gets or sets the direction of the cylinder (x,


y, z).
Property Radius

Gets or sets the radius of the cylinder.

Center
Gets or sets the center of the cylinder (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Direction
Gets or sets the direction of the cylinder (x, y, z).

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Radius
Gets or sets the radius of the cylinder.

Declaration Syntax
public double Radius { set;get; }

ISolids
Defines the list of all creatable solid geometry primitives.

Declaration Syntax
public interface ISolids
Table 32: Members
Method CreateBox(IEnumerable<double>, IEnumerable<double>) Creates a box primitive generator.
Method CreateCone(IEnumerable<double>,
IEnumerable<double>, double, double)

Creates a cone primitive


generator.

Method CreateCylinder(IEnumerable<double>,
IEnumerable<double>, double)

Creates a cylinder primitive


generator.

36

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISolids
Method CreateSphere(IEnumerable<double>, double)

Creates a sphere primitive


generator.

CreateBox(IEnumerable<double>, IEnumerable<double>)
Creates a box primitive generator.

Declaration Syntax
public ISolidBox CreateBox(IEnumerable<double> pt1, IEnumerable<double> pt2)

Parameters
pt1(IEnumerable<double>)
First point of the box.
pt2(IEnumerable<double>)
Second point of the box.

CreateCone(IEnumerable<double>, IEnumerable<double>, double, double)


Creates a cone primitive generator.

Declaration Syntax
public ISolidCone CreateCone(IEnumerable<double> center, IEnumerable<double> direction, double
radius1, double radius2)

Parameters
center(IEnumerable<double>)
Center of the cone.
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)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

37

Ansys.ACT.Interfaces.DesignModeler Namespace

Parameters
center(IEnumerable<double>)
The center of the cylinder.
direction(IEnumerable<double>)
The direction of the cylinder.
radius(double)
The radius of the cylinder.

CreateSphere(IEnumerable<double>, double)
Creates a sphere primitive generator.

Declaration Syntax
public ISolidSphere CreateSphere(IEnumerable<double> center, double radius)

Parameters
center(IEnumerable<double>)
The center of the sphere.
radius(double)
The radius of the sphere.

ISolidSphere
Defines a solid sphere primitive.

Declaration Syntax
public interface ISolidSphere
Table 33: Members
Property Center Gets or sets the center of the sphere (x,
y, z).
Property Radius 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.

38

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUnion

Declaration Syntax
public double Radius { set;get; }

ISubtract
Defines a "Subtract" operation.

Declaration Syntax
public interface ISubtract
Table 34: Members
Method ApplyTo(IEnumerable<IPSGeoBody>) 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 on which bodies will be subtracted.

IUnion
Defines an "Union" operation.

Declaration Syntax
public interface IUnion
Table 35: Members
Method ApplyTo(IEnumerable<IPSGeoBody>) 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)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

39

Ansys.ACT.Interfaces.DesignModeler Namespace

Parameters
bodiesIn(IEnumerable<IPSGeoBody>)
The list of bodies to combine.

IWireArc
Defines a wire arc primitive.

Declaration Syntax
public interface IWireArc
Table 36: Members
Property Center

Gets or sets the center of the arc (x, y, z).

Property EndAngle

Gets or sets the end angle of the arc.

Property Normal

Gets or sets the normal of the arc (x, y, z).

Property Radius

Gets or sets the radius of the arc.

Property StartAngle Gets or sets the start angle of the arc.


Property XDir

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.

40

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IWireBCurve

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).

Declaration Syntax
public IEnumerable<double> XDir { set;get; }

IWireBCurve
Defines awire b-curve primitive.

Declaration Syntax
public interface IWireBCurve
Table 37: Members
Property Closed Gets of sets the closed flag.
Property Points

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; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

41

Ansys.ACT.Interfaces.DesignModeler Namespace

IWireEllipse
Defines a wire ellipse primitive.

Declaration Syntax
public interface IWireEllipse
Table 38: Members
Property Center

Gets or sets the center of the ellipse (x, y, z).

Property LargeRadius Gets or sets the large radius of the ellipse.


Property Normal

Gets or sets the normal direction of the ellipse (x,


y, z).

Property SmallRadius Gets or sets the small radius of the ellipse.


Property XDir

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; }

42

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IWires

XDir
Gets or sets the principal direction of the ellipse (x, y, z).

Declaration Syntax
public IEnumerable<double> XDir { set;get; }

IWirePolyline
Defines a wire polyline primitive.

Declaration Syntax
public interface IWirePolyline
Table 39: Members
Property Points 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 40: Members
Method CreateArc(double, IEnumerable<double>,
IEnumerable<double>, IEnumerable<double>)

Creates an arc primitive


generator.

Method CreateBCurve(IEnumerable<double>)

Creates a b-curve primitive


generator.

Method CreateEllipse(double, double, IEnumerable<double>,


IEnumerable<double>, IEnumerable<double>)

Creates an ellipse primitive


generator.

Method CreatePolyline(IEnumerable<double>)

Creates a polyline primitive


generator.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

43

Ansys.ACT.Interfaces.DesignModeler Namespace

CreateArc(double, IEnumerable<double>, IEnumerable<double>, IEnumerable<double>)


Creates an arc primitive generator.

Declaration Syntax
public IWireArc CreateArc(double radius, IEnumerable<double> center, IEnumerable<double> xDir, IEnumerable<double> normal)

Parameters
radius(double)
The radius of the arc.
center(IEnumerable<double>)
The center of the arc.
xDir(IEnumerable<double>)
The main direction of the arc.
normal(IEnumerable<double>)
The normal direction of the arc.

CreateBCurve(IEnumerable<double>)
Creates a b-curve primitive generator.

Declaration Syntax
public IWireBCurve CreateBCurve(IEnumerable<double> points)

Parameters
points(IEnumerable<double>)
The list of points.

CreateEllipse(double, double, IEnumerable<double>, IEnumerable<double>,


IEnumerable<double>)
Creates an ellipse primitive generator.

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.

44

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IWires
smallRadius(double)
The small radius of the ellipse.
center(IEnumerable<double>)
The center of the ellipse.
xDir(IEnumerable<double>)
The main direction of the ellipse.
normal(IEnumerable<double>)
The normal direction of the ellipse.

CreatePolyline(IEnumerable<double>)
Creates a polyline primitive generator.

Declaration Syntax
public IWirePolyline CreatePolyline(IEnumerable<double> points)

Parameters
points(IEnumerable<double>)
The list of points.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

45

46

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical
Table 41: Members
CommandSnippet

Defines a CommandSnippet.

Comment

Defines a Comment.

Component

Defines a Component.

ComponentGroup

Defines a ComponentGroup.

CondensedPart

Defines a CondensedPart.

ConstructionGeometry

Defines a
ConstructionGeometry.

CoordinateSystem

Defines a CoordinateSystem.

CoordinateSystemGroup Defines a
CoordinateSystemGroup.
Environment

Defines a Environment.

Figure

Defines a Figure.

MeshControlGroup

Defines a
MeshControlGroup.

Model

Defines a Model.

Path

Defines a Path.

PointMass

Defines a PointMass.

Project

Defines a Project.

Prototype

Defines a Prototype.

PrototypeGroup

Defines a PrototypeGroup.

RemotePoint

Defines a RemotePoint.

RemotePointGroup

Defines a
RemotePointGroup.

Solution

Defines a Solution.

CommandSnippet
Defines a CommandSnippet.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

47

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CommandSnippet : DataModelObject
Table 42: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Figures

Gets the list of associated


figures.

Property InputArgument1

Gets or sets the


InputArgument1.

Property InputArgument2

Gets or sets the


InputArgument2.

Property InputArgument3

Gets or sets the


InputArgument3.

Property InputArgument4

Gets or sets the


InputArgument4.

Property InputArgument5

Gets or sets the


InputArgument5.

Property InputArgument6

Gets or sets the


InputArgument6.

Property InputArgument7

Gets or sets the


InputArgument7.

Property InputArgument8

Gets or sets the


InputArgument8.

Property InputArgument9

Gets or sets the


InputArgument9.

Property SnippetFilePath

Gets the SnippetFilePath.

Property SnippetFileStatus Gets the SnippetFileStatus.


Property SolverTarget

Gets the SolverTarget.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

48

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CommandSnippet

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

InputArgument1
Gets or sets the InputArgument1.

Declaration Syntax
public string InputArgument1 { set;get; }

InputArgument2
Gets or sets the InputArgument2.

Declaration Syntax
public string InputArgument2 { set;get; }

InputArgument3
Gets or sets the InputArgument3.

Declaration Syntax
public string InputArgument3 { set;get; }

InputArgument4
Gets or sets the InputArgument4.

Declaration Syntax
public string InputArgument4 { set;get; }

InputArgument5
Gets or sets the InputArgument5.

Declaration Syntax
public string InputArgument5 { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

49

Ansys.ACT.Automation.Mechanical Namespace

InputArgument6
Gets or sets the InputArgument6.

Declaration Syntax
public string InputArgument6 { set;get; }

InputArgument7
Gets or sets the InputArgument7.

Declaration Syntax
public string InputArgument7 { set;get; }

InputArgument8
Gets or sets the InputArgument8.

Declaration Syntax
public string InputArgument8 { set;get; }

InputArgument9
Gets or sets the InputArgument9.

Declaration Syntax
public string InputArgument9 { set;get; }

SnippetFilePath
Gets the SnippetFilePath.

Declaration Syntax
public string SnippetFilePath { get; }

SnippetFileStatus
Gets the SnippetFileStatus.

Declaration Syntax
public int SnippetFileStatus { get; }

SolverTarget
Gets the SolverTarget.

50

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Comment

Declaration Syntax
public CommandEditorTarget SolverTarget { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Comment
Defines a Comment.

Declaration Syntax
public class Comment : DataModelObject
Table 43: Members
Property Author

Gets the Author.

Property Children Gets the list of


children.
Property Text

Gets the Text.

Author
Gets the Author.

Declaration Syntax
public string Author { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

51

Ansys.ACT.Automation.Mechanical Namespace

Children
Gets the list of children.

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

Text
Gets the Text.

Declaration Syntax
public string Text { get; }

Component
Defines a Component.

Declaration Syntax
public class Component : DataModelObject
Table 44: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property Figures

Gets the list of associated figures.

Property Geometry

Gets or sets the Geometry.

Property ImportedFromCAD

Gets the ImportedFromCAD.

Property IncludeProgramControlledInflation Gets or sets the


IncludeProgramControlledInflation.
Property NumberOfSuppressedItems

Gets the NumberOfSuppressedItems.

Property RelativeTolerance

Gets or sets the RelativeTolerance.

Property SendToSolver

Gets or sets the SendToSolver.

Property ToleranceType

Gets or sets the ToleranceType.

Property TotalSelection

Gets the TotalSelection.

Property UsedByMeshWorksheet

Gets the UsedByMeshWorksheet.

Property Visible

Gets or sets the Visible.

Property ZeroTolerance

Gets or sets the ZeroTolerance.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

52

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Component

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Geometry
Gets or sets the Geometry.

Declaration Syntax
public ISelectionInfo Geometry { set;get; }

ImportedFromCAD
Gets the ImportedFromCAD.

Declaration Syntax
public bool ImportedFromCAD { get; }

IncludeProgramControlledInflation
Gets or sets the IncludeProgramControlledInflation.

Declaration Syntax
public bool IncludeProgramControlledInflation { set;get; }

NumberOfSuppressedItems
Gets the NumberOfSuppressedItems.

Declaration Syntax
public int NumberOfSuppressedItems { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

53

Ansys.ACT.Automation.Mechanical Namespace

RelativeTolerance
Gets or sets the RelativeTolerance.

Declaration Syntax
public double RelativeTolerance { set;get; }

SendToSolver
Gets or sets the SendToSolver.

Declaration Syntax
public bool SendToSolver { set;get; }

ToleranceType
Gets or sets the ToleranceType.

Declaration Syntax
public ToleranceType ToleranceType { set;get; }

TotalSelection
Gets the TotalSelection.

Declaration Syntax
public int TotalSelection { get; }

UsedByMeshWorksheet
Gets the UsedByMeshWorksheet.

Declaration Syntax
public bool UsedByMeshWorksheet { get; }

Visible
Gets or sets the Visible.

Declaration Syntax
public bool Visible { set;get; }

ZeroTolerance
Gets or sets the ZeroTolerance.

54

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ComponentGroup

Declaration Syntax
public double ZeroTolerance { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

ComponentGroup
Defines a ComponentGroup.

Declaration Syntax
public class ComponentGroup : DataModelObject
Table 45: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Components

Gets the Components.

Property Figures

Gets the list of associated


figures.

Property GenerateOnRefresh

Gets or sets the


GenerateOnRefresh.

Property GenerateOnRemesh Gets or sets the


GenerateOnRemesh.
Property RandomColors

Gets the RandomColors.

Property ShowAnnotations

Gets or sets the


ShowAnnotations.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

55

Ansys.ACT.Automation.Mechanical Namespace

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Components
Gets the Components.

Declaration Syntax
public IEnumerable<Component> Components { 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; }

RandomColors
Gets the RandomColors.

Declaration Syntax
public bool RandomColors { get; }

56

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CondensedPart

ShowAnnotations
Gets or sets the ShowAnnotations.

Declaration Syntax
public bool ShowAnnotations { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

CondensedPart
Defines a CondensedPart.

Declaration Syntax
public class CondensedPart : DataModelObject
Table 46: Members
Property Children

Gets the list of children.

Property FutureIntent

Gets or sets the FutureIntent.

Property GeometrySelection

Gets or sets the


GeometrySelection.

Property InterfaceMethod

Gets or sets the InterfaceMethod.

Property InteriorConnections

Gets the InteriorConnections.

Property MaxFrequency

Gets or sets the MaxFrequency.

Property MinFrequency

Gets or sets the MinFrequency.

Property NumberOfModes

Gets or sets the NumberOfModes.

Property NumInterfaceEntries

Gets the NumInterfaceEntries.

Property NumMasterNodes

Gets the NumMasterNodes.

Property Physics

Gets the Physics.

Property RangeSearch

Gets or sets the RangeSearch.

Property ReductionMethod

Gets or sets the


ReductionMethod.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

57

Ansys.ACT.Automation.Mechanical Namespace
Property ReferenceTemperature Gets or sets the
ReferenceTemperature.
Property SolutionName

Gets or sets the SolutionName.

Property SolutionNameMode

Gets or sets the


SolutionNameMode.

Property SolverFilesDirectory

Gets the SolverFilesDirectory.

Property Suppressed

Gets or sets the Suppressed.

Property TemperatureUnits

Gets the TemperatureUnits.

Children
Gets the list of children.

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

FutureIntent
Gets or sets the FutureIntent.

Declaration Syntax
public FutureIntent FutureIntent { set;get; }

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

InterfaceMethod
Gets or sets the InterfaceMethod.

Declaration Syntax
public CondensedPartInterfaceMethod InterfaceMethod { set;get; }

InteriorConnections
Gets the InteriorConnections.

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

58

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CondensedPart

MaxFrequency
Gets or sets the MaxFrequency.

Declaration Syntax
public Quantity MaxFrequency { set;get; }

MinFrequency
Gets or sets the MinFrequency.

Declaration Syntax
public Quantity MinFrequency { set;get; }

NumberOfModes
Gets or sets the NumberOfModes.

Declaration Syntax
public int NumberOfModes { set;get; }

NumInterfaceEntries
Gets the NumInterfaceEntries.

Declaration Syntax
public int NumInterfaceEntries { get; }

NumMasterNodes
Gets the NumMasterNodes.

Declaration Syntax
public int NumMasterNodes { get; }

Physics
Gets the Physics.

Declaration Syntax
public CondensedPartPhysics Physics { get; }

RangeSearch
Gets or sets the RangeSearch.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

59

Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public string SolutionName { set;get; }

SolutionNameMode
Gets or sets the SolutionNameMode.

Declaration Syntax
public AutoOrManual SolutionNameMode { set;get; }

SolverFilesDirectory
Gets the SolverFilesDirectory.

Declaration Syntax
public string SolverFilesDirectory { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

60

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ConstructionGeometry

TemperatureUnits
Gets the TemperatureUnits.

Declaration Syntax
public string TemperatureUnits { get; }

ConstructionGeometry
Defines a ConstructionGeometry.

Declaration Syntax
public class ConstructionGeometry : DataModelObject
Table 47: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Figures

Gets the list of associated


figures.

Property Paths

Gets the Paths.

Property ShowMesh

Gets or sets the ShowMesh.

Method AddComment() Creates a new child Comment.


Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

61

Ansys.ACT.Automation.Mechanical Namespace

Paths
Gets the Paths.

Declaration Syntax
public IEnumerable<Path> Paths { get; }

ShowMesh
Gets or sets the ShowMesh.

Declaration Syntax
public bool ShowMesh { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

CoordinateSystem
Defines a CoordinateSystem.

Declaration Syntax
public class CoordinateSystem : DataModelObject
Table 48: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property CoordinateSystemType Gets or sets the


CoordinateSystemType.
Property EulerAngleXY

Gets the EulerAngleXY.

Property EulerAngleYZ

Gets the EulerAngleYZ.

Property EulerAngleZX

Gets the EulerAngleZX.

Property Figures

Gets the list of associated figures.

62

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CoordinateSystem
Property GloballyAvailable

Gets or sets the GloballyAvailable.

Property IsGlobal

Gets the IsGlobal.

Property ReadOnly

Gets the ReadOnly.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystemType
Gets or sets the CoordinateSystemType.

Declaration Syntax
public CoordinateSystemType CoordinateSystemType { set;get; }

EulerAngleXY
Gets the EulerAngleXY.

Declaration Syntax
public Quantity EulerAngleXY { get; }

EulerAngleYZ
Gets the EulerAngleYZ.

Declaration Syntax
public Quantity EulerAngleYZ { get; }

EulerAngleZX
Gets the EulerAngleZX.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

63

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity EulerAngleZX { 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; }

IsGlobal
Gets the IsGlobal.

Declaration Syntax
public bool IsGlobal { get; }

ReadOnly
Gets the ReadOnly.

Declaration Syntax
public bool ReadOnly { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

64

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CoordinateSystemGroup

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

CoordinateSystemGroup
Defines a CoordinateSystemGroup.

Declaration Syntax
public class CoordinateSystemGroup : DataModelObject
Table 49: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property CoordinateSystems Gets the CoordinateSystems.


Property Figures

Gets the list of associated


figures.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystems
Gets the CoordinateSystems.

Declaration Syntax
public IEnumerable<CoordinateSystem> CoordinateSystems { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

65

Ansys.ACT.Automation.Mechanical Namespace

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Environment
Defines a Environment.

Declaration Syntax
public class Environment : DataModelObject
Table 50: Members
Property CellId

Gets the CellId.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Figures

Gets the list of associated


figures.

Property Solution

Gets the Solution.

Property SolverName

Gets the SolverName.

Property SystemCaption

Gets the SystemCaption.

Property Temperature

Gets or sets the Temperature.

Property WorkingDir

Gets the WorkingDir.

Method AddComment()

Creates a new child Comment.

Method AddEarthGravity()

Creates a new child


EarthGravity.

Method AddFigure()

Creates a new child Figure.

66

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Environment
Method AddFixedSupport() Creates a new child
FixedSupport.

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Solution
Gets the Solution.

Declaration Syntax
public Solution Solution { get; }

SolverName
Gets the SolverName.

Declaration Syntax
public string SolverName { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

67

Ansys.ACT.Automation.Mechanical Namespace

SystemCaption
Gets the SystemCaption.

Declaration Syntax
public string SystemCaption { get; }

Temperature
Gets or sets the Temperature.

Declaration Syntax
public Quantity Temperature { set;get; }

WorkingDir
Gets the WorkingDir.

Declaration Syntax
public string WorkingDir { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddEarthGravity()
Creates a new child EarthGravity.

Declaration Syntax
public EarthGravity AddEarthGravity()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

AddFixedSupport()
Creates a new child FixedSupport.

68

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Figure

Declaration Syntax
public FixedSupport AddFixedSupport()

Figure
Defines a Figure.

Declaration Syntax
public class Figure : DataModelObject
Table 51: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Text

Gets the Text.

Method AddComment() Creates a new child Comment.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Text
Gets the Text.

Declaration Syntax
public string Text { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

69

Ansys.ACT.Automation.Mechanical Namespace

MeshControlGroup
Defines a MeshControlGroup.

Declaration Syntax
public class MeshControlGroup : DataModelObject
Table 52: Members
Property AdvancedInflation

Gets or sets the AdvancedInflation.

Property AdvancedSizeFunction

Gets or sets the AdvancedSizeFunction.

Property AutomaticInflation

Gets or sets the AutomaticInflation.

Property AutoMeshDefeaturing

Gets or sets the AutoMeshDefeaturing.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property DefeatureTolerance

Gets the DefeatureTolerance.

Property DisplayStyle

Gets or sets the DisplayStyle.

Property ElementCount

Gets the ElementCount.

Property ElementOrder

Gets or sets the ElementOrder.

Property ElementSize

Gets or sets the ElementSize.

Property ExpansionFactor

Gets or sets the ExpansionFactor.

Property ExtraRetriesForAssembly

Gets or sets the ExtraRetriesForAssembly.

Property Figures

Gets the list of associated figures.

Property GrowthRateSF

Gets or sets the GrowthRateSF.

Property InflationAlgorithm

Gets or sets the InflationAlgorithm.

Property InflationOption

Gets or sets the InflationOption.

Property InitialSizeSeed

Gets or sets the InitialSizeSeed.

Property MaxFaceElementSize

Gets or sets the MaxFaceElementSize.

Property MaximumLayers

Gets or sets the MaximumLayers.

Property MaxSizeSF

Gets or sets the MaxSizeSF.

Property MeshControls

Gets the MeshControls.

Property MeshMetric

Gets or sets the MeshMetric.

Property MeshMetricAverage

Gets the MeshMetricAverage.

Property MeshMetricMax

Gets the MeshMetricMax.

Property MeshMetricMin

Gets the MeshMetricMin.

Property MeshMetricSTDV

Gets the MeshMetricSTDV.

Property MeshMorphing

Gets or sets the MeshMorphing.

Property MinEdgeSize

Gets the MinEdgeSize.

Property MinSizeSF

Gets or sets the MinSizeSF.

Property NodeCount

Gets the NodeCount.

Property NumberOfRetries

Gets or sets the NumberOfRetries.

70

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshControlGroup
Property NumCpuPartMeshing

Gets or sets the NumCpuPartMeshing.

Property PhysicsPreference

Gets or sets the PhysicsPreference.

Property PinchGenerateOnRefresh

Gets or sets the PinchGenerateOnRefresh.

Property PinchTolerance

Gets or sets the PinchTolerance.

Property Relevance

Gets or sets the Relevance.

Property RelevanceCenter

Gets or sets the RelevanceCenter.

Property RigidBodyBehavior

Gets the RigidBodyBehavior.

Property ShapeChecking

Gets or sets the ShapeChecking.

Property SmoothingOption

Gets or sets the SmoothingOption.

Property SolverPreference

Gets or sets the SolverPreference.

Property SpanAngleOption

Gets or sets the SpanAngleOption.

Property SpanningAngleSF

Gets or sets the SpanningAngleSF.

Property StraightSideElement

Gets or sets the StraightSideElement.

Property TopologyChecks

Gets or sets the TopologyChecks.

Property TransitionOption

Gets or sets the TransitionOption.

Property TransitionRatio

Gets or sets the TransitionRatio.

Property TriangleSurfaceMesh

Gets or sets the TriangleSurfaceMesh.

Method AddComment()

Creates a new child Comment.

Method AddContactSizingMeshControl() Creates a new child


ContactSizingMeshControl.
Method AddFaceMeshingMeshControl()

Creates a new child


FaceMeshingMeshControl.

Method AddFigure()

Creates a new child Figure.

Method AddInflationMeshControl()

Creates a new child InflationMeshControl.

Method AddMatchMeshControl()

Creates a new child MatchMeshControl.

Method AddMethodMeshControl()

Creates a new child MethodMeshControl.

Method AddPinchMeshControl()

Creates a new child PinchMeshControl.

Method AddRefinementMeshControl()

Creates a new child


RefinementMeshControl.

Method AddSizingMeshControl()

Creates a new child SizingMeshControl.

AdvancedInflation
Gets or sets the AdvancedInflation.

Declaration Syntax
public bool AdvancedInflation { set;get; }

AdvancedSizeFunction
Gets or sets the AdvancedSizeFunction.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

71

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public OnOff AdvancedSizeFunction { set;get; }

AutomaticInflation
Gets or sets the AutomaticInflation.

Declaration Syntax
public int AutomaticInflation { set;get; }

AutoMeshDefeaturing
Gets or sets the AutoMeshDefeaturing.

Declaration Syntax
public int AutoMeshDefeaturing { set;get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DefeatureTolerance
Gets the DefeatureTolerance.

Declaration Syntax
public Quantity DefeatureTolerance { get; }

DisplayStyle
Gets or sets the DisplayStyle.

Declaration Syntax
public MeshDisplayStyle DisplayStyle { set;get; }

72

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshControlGroup

ElementCount
Gets the ElementCount.

Declaration Syntax
public int ElementCount { get; }

ElementOrder
Gets or sets the ElementOrder.

Declaration Syntax
public int ElementOrder { set;get; }

ElementSize
Gets or sets the ElementSize.

Declaration Syntax
public Quantity ElementSize { set;get; }

ExpansionFactor
Gets or sets the ExpansionFactor.

Declaration Syntax
public double ExpansionFactor { 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; }

GrowthRateSF
Gets or sets the GrowthRateSF.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

73

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double GrowthRateSF { 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; }

InitialSizeSeed
Gets or sets the InitialSizeSeed.

Declaration Syntax
public int InitialSizeSeed { set;get; }

MaxFaceElementSize
Gets or sets the MaxFaceElementSize.

Declaration Syntax
public Quantity MaxFaceElementSize { set;get; }

MaximumLayers
Gets or sets the MaximumLayers.

Declaration Syntax
public int MaximumLayers { set;get; }

MaxSizeSF
Gets or sets the MaxSizeSF.

Declaration Syntax
public Quantity MaxSizeSF { set;get; }

74

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshControlGroup

MeshControls
Gets the MeshControls.

Declaration Syntax
public IEnumerable<MeshControl> MeshControls { get; }

MeshMetric
Gets or sets the MeshMetric.

Declaration Syntax
public int MeshMetric { set;get; }

MeshMetricAverage
Gets the MeshMetricAverage.

Declaration Syntax
public double MeshMetricAverage { get; }

MeshMetricMax
Gets the MeshMetricMax.

Declaration Syntax
public double MeshMetricMax { get; }

MeshMetricMin
Gets the MeshMetricMin.

Declaration Syntax
public double MeshMetricMin { get; }

MeshMetricSTDV
Gets the MeshMetricSTDV.

Declaration Syntax
public double MeshMetricSTDV { get; }

MeshMorphing
Gets or sets the MeshMorphing.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

75

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool MeshMorphing { set;get; }

MinEdgeSize
Gets the MinEdgeSize.

Declaration Syntax
public Quantity MinEdgeSize { get; }

MinSizeSF
Gets or sets the MinSizeSF.

Declaration Syntax
public Quantity MinSizeSF { set;get; }

NodeCount
Gets the NodeCount.

Declaration Syntax
public int NodeCount { get; }

NumberOfRetries
Gets or sets the NumberOfRetries.

Declaration Syntax
public int NumberOfRetries { set;get; }

NumCpuPartMeshing
Gets or sets the NumCpuPartMeshing.

Declaration Syntax
public int NumCpuPartMeshing { set;get; }

PhysicsPreference
Gets or sets the PhysicsPreference.

Declaration Syntax
public int PhysicsPreference { set;get; }

76

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshControlGroup

PinchGenerateOnRefresh
Gets or sets the PinchGenerateOnRefresh.

Declaration Syntax
public int PinchGenerateOnRefresh { set;get; }

PinchTolerance
Gets or sets the PinchTolerance.

Declaration Syntax
public Quantity PinchTolerance { set;get; }

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; }

RigidBodyBehavior
Gets the RigidBodyBehavior.

Declaration Syntax
public int RigidBodyBehavior { get; }

ShapeChecking
Gets or sets the ShapeChecking.

Declaration Syntax
public int ShapeChecking { set;get; }

SmoothingOption
Gets or sets the SmoothingOption.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

77

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int SmoothingOption { set;get; }

SolverPreference
Gets or sets the SolverPreference.

Declaration Syntax
public int SolverPreference { set;get; }

SpanAngleOption
Gets or sets the SpanAngleOption.

Declaration Syntax
public int SpanAngleOption { set;get; }

SpanningAngleSF
Gets or sets the SpanningAngleSF.

Declaration Syntax
public Quantity SpanningAngleSF { set;get; }

StraightSideElement
Gets or sets the StraightSideElement.

Declaration Syntax
public bool StraightSideElement { set;get; }

TopologyChecks
Gets or sets the TopologyChecks.

Declaration Syntax
public YesNo TopologyChecks { set;get; }

TransitionOption
Gets or sets the TransitionOption.

Declaration Syntax
public int TransitionOption { set;get; }

78

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshControlGroup

TransitionRatio
Gets or sets the TransitionRatio.

Declaration Syntax
public double TransitionRatio { set;get; }

TriangleSurfaceMesh
Gets or sets the TriangleSurfaceMesh.

Declaration Syntax
public int TriangleSurfaceMesh { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddContactSizingMeshControl()
Creates a new child ContactSizingMeshControl.

Declaration Syntax
public ContactSizingMeshControl AddContactSizingMeshControl()

AddFaceMeshingMeshControl()
Creates a new child FaceMeshingMeshControl.

Declaration Syntax
public FaceMeshingMeshControl AddFaceMeshingMeshControl()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

AddInflationMeshControl()
Creates a new child InflationMeshControl.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

79

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public InflationMeshControl AddInflationMeshControl()

AddMatchMeshControl()
Creates a new child MatchMeshControl.

Declaration Syntax
public MatchMeshControl AddMatchMeshControl()

AddMethodMeshControl()
Creates a new child MethodMeshControl.

Declaration Syntax
public MethodMeshControl AddMethodMeshControl()

AddPinchMeshControl()
Creates a new child PinchMeshControl.

Declaration Syntax
public PinchMeshControl AddPinchMeshControl()

AddRefinementMeshControl()
Creates a new child RefinementMeshControl.

Declaration Syntax
public RefinementMeshControl AddRefinementMeshControl()

AddSizingMeshControl()
Creates a new child SizingMeshControl.

Declaration Syntax
public SizingMeshControl AddSizingMeshControl()

Model
Defines a Model.

80

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Model

Declaration Syntax
public class Model : DataModelObject
Table 53: Members
Property CellId

Gets the CellId.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property ComponentGroup

Gets the ComponentGroup.

Property ConnectionGroup

Gets the ConnectionGroup.

Property CoordinateSystemGroup

Gets the CoordinateSystemGroup.

Property Environments

Gets the Environments.

Property Figures

Gets the list of associated figures.

Property MeshControlGroup

Gets the MeshControlGroup.

Property PrototypeGroup

Gets the PrototypeGroup.

Property Prototypes

Gets the Prototypes.

Property RemotePointGroup

Gets the RemotePointGroup.

Property SystemCaption

Gets the SystemCaption.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Method AddRemotePointGroup() Creates a new child


RemotePointGroup.

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

81

Ansys.ACT.Automation.Mechanical Namespace

ComponentGroup
Gets the ComponentGroup.

Declaration Syntax
public ComponentGroup ComponentGroup { get; }

ConnectionGroup
Gets the ConnectionGroup.

Declaration Syntax
public ConnectionGroup ConnectionGroup { get; }

CoordinateSystemGroup
Gets the CoordinateSystemGroup.

Declaration Syntax
public CoordinateSystemGroup CoordinateSystemGroup { get; }

Environments
Gets the Environments.

Declaration Syntax
public IEnumerable<Environment> Environments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

MeshControlGroup
Gets the MeshControlGroup.

Declaration Syntax
public MeshControlGroup MeshControlGroup { get; }

PrototypeGroup
Gets the PrototypeGroup.

82

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Model

Declaration Syntax
public PrototypeGroup PrototypeGroup { get; }

Prototypes
Gets the Prototypes.

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

RemotePointGroup
Gets the RemotePointGroup.

Declaration Syntax
public RemotePointGroup RemotePointGroup { get; }

SystemCaption
Gets the SystemCaption.

Declaration Syntax
public string SystemCaption { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

AddRemotePointGroup()
Creates a new child RemotePointGroup.

Declaration Syntax
public RemotePointGroup AddRemotePointGroup()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

83

Ansys.ACT.Automation.Mechanical Namespace

Path
Defines a Path.

Declaration Syntax
public class Path : DataModelObject
Table 54: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property CoordinateSystemSelection

Gets or sets the


CoordinateSystemSelection.

Property EdgeSelection

Gets the EdgeSelection.

Property EndCoordinateSystemSelection

Gets or sets the


EndCoordinateSystemSelection.

Property EndLocationX

Gets or sets the EndLocationX.

Property EndLocationY

Gets or sets the EndLocationY.

Property EndLocationZ

Gets or sets the EndLocationZ.

Property Figures

Gets the list of associated figures.

Property HasValidGeometrySelection

Gets the HasValidGeometrySelection.

Property NumberOfSamplingPoints

Gets or sets the NumberOfSamplingPoints.

Property PathScopingType

Gets or sets the PathScopingType.

Property ShowMesh

Gets or sets the ShowMesh.

Property SnapToMesh

Gets or sets the SnapToMesh.

Property StartCoordinateSystemSelection Gets or sets the


StartCoordinateSystemSelection.
Property StartLocationX

Gets or sets the StartLocationX.

Property StartLocationY

Gets or sets the StartLocationY.

Property StartLocationZ

Gets or sets the StartLocationZ.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

84

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Path

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystemSelection
Gets or sets the CoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem CoordinateSystemSelection { set;get; }

EdgeSelection
Gets the EdgeSelection.

Declaration Syntax
public ISelectionInfo EdgeSelection { get; }

EndCoordinateSystemSelection
Gets or sets the EndCoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem EndCoordinateSystemSelection { set;get; }

EndLocationX
Gets or sets the EndLocationX.

Declaration Syntax
public Quantity EndLocationX { set;get; }

EndLocationY
Gets or sets the EndLocationY.

Declaration Syntax
public Quantity EndLocationY { set;get; }

EndLocationZ
Gets or sets the EndLocationZ.

Declaration Syntax
public Quantity EndLocationZ { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

85

Ansys.ACT.Automation.Mechanical Namespace

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

HasValidGeometrySelection
Gets the HasValidGeometrySelection.

Declaration Syntax
public bool HasValidGeometrySelection { get; }

NumberOfSamplingPoints
Gets or sets the NumberOfSamplingPoints.

Declaration Syntax
public int NumberOfSamplingPoints { set;get; }

PathScopingType
Gets or sets the PathScopingType.

Declaration Syntax
public PathScoping PathScopingType { set;get; }

ShowMesh
Gets or sets the ShowMesh.

Declaration Syntax
public bool ShowMesh { set;get; }

SnapToMesh
Gets or sets the SnapToMesh.

Declaration Syntax
public bool SnapToMesh { set;get; }

StartCoordinateSystemSelection
Gets or sets the StartCoordinateSystemSelection.

86

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Path

Declaration Syntax
public ICoordinateSystem StartCoordinateSystemSelection { set;get; }

StartLocationX
Gets or sets the StartLocationX.

Declaration Syntax
public Quantity StartLocationX { set;get; }

StartLocationY
Gets or sets the StartLocationY.

Declaration Syntax
public Quantity StartLocationY { set;get; }

StartLocationZ
Gets or sets the StartLocationZ.

Declaration Syntax
public Quantity StartLocationZ { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

87

Ansys.ACT.Automation.Mechanical Namespace

PointMass
Defines a PointMass.

Declaration Syntax
public class PointMass : DataModelObject
Table 55: Members
Property AppliedBy

Gets or sets the AppliedBy.

Property Behavior

Gets or sets the Behavior.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property CoordinateSystem

Gets or sets the CoordinateSystem.

Property DistributedMassInputType Gets or sets the DistributedMassInputType.


Property Figures

Gets the list of associated figures.

Property IsDistributedMass

Gets the IsDistributedMass.

Property Mass

Gets or sets the Mass.

Property MassMomentOfInertiaX

Gets or sets the MassMomentOfInertiaX.

Property MassMomentOfInertiaY

Gets or sets the MassMomentOfInertiaY.

Property MassMomentOfInertiaZ

Gets or sets the MassMomentOfInertiaZ.

Property MassPerUnitArea

Gets or sets the MassPerUnitArea.

Property PinballSize

Gets or sets the PinballSize.

Property Prototypes

Gets the Prototypes.

Property RemotePoint

Gets the remote point associated to the point


mass.

Property Scope

Gets or sets the Geometry.

Property Suppressed

Gets or sets the Suppressed.

Property ThermalCapacitance

Gets or sets the ThermalCapacitance.

Property TotalMass

Gets or sets the TotalMass.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

AppliedBy
Gets or sets the AppliedBy.

Declaration Syntax
public RemoteApplicationType AppliedBy { set;get; }

Behavior
Gets or sets the Behavior.

88

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PointMass

Declaration Syntax
public LoadBehaviorType Behavior { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IEnumerable<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 ICoordinateSystem CoordinateSystem { set;get; }

DistributedMassInputType
Gets or sets the DistributedMassInputType.

Declaration Syntax
public DistributedMassInputType DistributedMassInputType { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

IsDistributedMass
Gets the IsDistributedMass.

Declaration Syntax
public bool IsDistributedMass { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

89

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; }

MassPerUnitArea
Gets or sets the MassPerUnitArea.

Declaration Syntax
public Quantity MassPerUnitArea { set;get; }

PinballSize
Gets or sets the PinballSize.

Declaration Syntax
public Quantity PinballSize { set;get; }

Prototypes
Gets the Prototypes.

90

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PointMass

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

RemotePoint
Gets the remote point associated to the point mass.

Declaration Syntax
public RemotePoint RemotePoint { get; }

Scope
Gets or sets the Geometry.

Declaration Syntax
public ISelectionInfo Scope { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ThermalCapacitance
Gets or sets the ThermalCapacitance.

Declaration Syntax
public Quantity ThermalCapacitance { set;get; }

TotalMass
Gets or sets the TotalMass.

Declaration Syntax
public Quantity TotalMass { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

91

Ansys.ACT.Automation.Mechanical Namespace

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Project
Defines a Project.

Declaration Syntax
public class Project : DataModelObject
Table 56: Members
Property Author

Gets or sets the Author.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property CreationDate

Gets the CreationDate.

Property CreationTime

Gets the CreationTime.

Property Models

Gets the Models.

Property PreparedFor

Gets the PreparedFor.

Property Subject

Gets the Subject.

Method AddComment() Creates a new child Comment.

Author
Gets or sets the Author.

Declaration Syntax
public string Author { set;get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

92

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Project

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CreationDate
Gets the CreationDate.

Declaration Syntax
public string CreationDate { get; }

CreationTime
Gets the CreationTime.

Declaration Syntax
public string CreationTime { get; }

Models
Gets the Models.

Declaration Syntax
public IEnumerable<Model> Models { get; }

PreparedFor
Gets the PreparedFor.

Declaration Syntax
public string PreparedFor { get; }

Subject
Gets the Subject.

Declaration Syntax
public string Subject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

93

Ansys.ACT.Automation.Mechanical Namespace

Prototype
Defines a Prototype.

Declaration Syntax
public class Prototype : DataModelObject
Table 57: Members
Property BoundingBoxLengthX

Gets the BoundingBoxLengthX.

Property BoundingBoxLengthY

Gets the BoundingBoxLengthY.

Property BoundingBoxLengthZ

Gets the BoundingBoxLengthZ.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property CoordinateSystem

Gets or sets the CoordinateSystem.

Property CrossSectionArea

Gets the CrossSectionArea.

Property Elements

Gets the Elements.

Property Figures

Gets the list of associated figures.

Property IsWindingBody

Gets the IsWindingBody.

Property Mass

Gets the Mass.

Property MassCentroidX

Gets the MassCentroidX.

Property MassCentroidY

Gets the MassCentroidY.

Property MassCentroidZ

Gets the MassCentroidZ.

Property MassMomentOfInertiaP1

Gets the MassMomentOfInertiaP1.

Property MassMomentOfInertiaP2

Gets the MassMomentOfInertiaP2.

Property MassMomentOfInertiaP3

Gets the MassMomentOfInertiaP3.

Property MaterialAssignment

Gets or sets the MaterialAssignment.

Property MeshMetric

Gets the MeshMetric.

Property Nodes

Gets the Nodes.

Property NonlinearMaterialEffects

Gets or sets the


NonlinearMaterialEffects.

Property ReadOnly

Gets the ReadOnly.

Property ReferenceTemperature

Gets or sets the ReferenceTemperature.

Property StiffnessBehavior

Gets or sets the StiffnessBehavior.

Property Suppressed

Gets or sets the Suppressed.

Property ThermalStrainMaterialEffects Gets or sets the


ThermalStrainMaterialEffects.
Property Thickness

Gets or sets the Thickness.

Property ThicknessMode

Gets the ThicknessMode.

Property UseReferenceTemperature

Gets or sets the


UseReferenceTemperature.

Property UserNameChange

Gets the UserNameChange.

94

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Prototype
Property Version

Gets the Version.

Property Visible

Gets or sets the Visible.

Property Volume

Gets the Volume.

Property WireLength

Gets the WireLength.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

BoundingBoxLengthX
Gets the BoundingBoxLengthX.

Declaration Syntax
public Quantity BoundingBoxLengthX { get; }

BoundingBoxLengthY
Gets the BoundingBoxLengthY.

Declaration Syntax
public Quantity BoundingBoxLengthY { get; }

BoundingBoxLengthZ
Gets the BoundingBoxLengthZ.

Declaration Syntax
public Quantity BoundingBoxLengthZ { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

95

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ICoordinateSystem CoordinateSystem { set;get; }

CrossSectionArea
Gets the CrossSectionArea.

Declaration Syntax
public Quantity CrossSectionArea { 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; }

IsWindingBody
Gets the IsWindingBody.

Declaration Syntax
public bool IsWindingBody { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

MassCentroidX
Gets the MassCentroidX.

Declaration Syntax
public Quantity MassCentroidX { get; }

96

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Prototype

MassCentroidY
Gets the MassCentroidY.

Declaration Syntax
public Quantity MassCentroidY { get; }

MassCentroidZ
Gets the MassCentroidZ.

Declaration Syntax
public Quantity MassCentroidZ { get; }

MassMomentOfInertiaP1
Gets the MassMomentOfInertiaP1.

Declaration Syntax
public Quantity MassMomentOfInertiaP1 { get; }

MassMomentOfInertiaP2
Gets the MassMomentOfInertiaP2.

Declaration Syntax
public Quantity MassMomentOfInertiaP2 { get; }

MassMomentOfInertiaP3
Gets the MassMomentOfInertiaP3.

Declaration Syntax
public Quantity MassMomentOfInertiaP3 { get; }

MaterialAssignment
Gets or sets the MaterialAssignment.

Declaration Syntax
public string MaterialAssignment { set;get; }

MeshMetric
Gets the MeshMetric.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

97

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int MeshMetric { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

NonlinearMaterialEffects
Gets or sets the NonlinearMaterialEffects.

Declaration Syntax
public bool NonlinearMaterialEffects { set;get; }

ReadOnly
Gets the ReadOnly.

Declaration Syntax
public bool ReadOnly { get; }

ReferenceTemperature
Gets or sets the ReferenceTemperature.

Declaration Syntax
public Quantity ReferenceTemperature { set;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; }

98

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Prototype

ThermalStrainMaterialEffects
Gets or sets the ThermalStrainMaterialEffects.

Declaration Syntax
public bool ThermalStrainMaterialEffects { set;get; }

Thickness
Gets or sets the Thickness.

Declaration Syntax
public Quantity Thickness { set;get; }

ThicknessMode
Gets the ThicknessMode.

Declaration Syntax
public bool ThicknessMode { get; }

UseReferenceTemperature
Gets or sets the UseReferenceTemperature.

Declaration Syntax
public bool UseReferenceTemperature { set;get; }

UserNameChange
Gets the UserNameChange.

Declaration Syntax
public bool UserNameChange { get; }

Version
Gets the Version.

Declaration Syntax
public int Version { get; }

Visible
Gets or sets the Visible.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

99

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Visible { set;get; }

Volume
Gets the Volume.

Declaration Syntax
public Quantity Volume { get; }

WireLength
Gets the WireLength.

Declaration Syntax
public Quantity WireLength { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

PrototypeGroup
Defines a PrototypeGroup.

Declaration Syntax
public class PrototypeGroup : DataModelObject
Table 58: Members
Property BoundingBoxLengthX

Gets the BoundingBoxLengthX.

Property BoundingBoxLengthY

Gets the BoundingBoxLengthY.

Property BoundingBoxLengthZ

Gets the BoundingBoxLengthZ.

Property CADAttribPrefixes

Gets the CADAttribPrefixes.

Property CADFile

Gets the CADFile.

100

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PrototypeGroup
Property CADNamedSelPrefixes

Gets the CADNamedSelPrefixes.

Property CanChangeCADUnits

Gets the CanChangeCADUnits.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property DoSmartUpdate

Gets the DoSmartUpdate.

Property Elements

Gets the Elements.

Property FiberLength

Gets the FiberLength.

Property Figures

Gets the list of associated figures.

Property GeometryPreferencesReadOnly Gets the


GeometryPreferencesReadOnly.
Property GeometryType

Gets the GeometryType.

Property ImportCoordinateSystems

Gets the
ImportCoordinateSystems.

Property ImportEnclosureAndSymmetry

Gets the
ImportEnclosureAndSymmetry.

Property ImportSheets

Gets the ImportSheets.

Property ImportSolids

Gets the ImportSolids.

Property ImportWires

Gets the ImportWires.

Property Mass

Gets the Mass.

Property MeshVolume

Gets the MeshVolume.

Property Model2DBehavior

Gets or sets the Model2DBehavior.

Property Nodes

Gets the Nodes.

Property NumActiveParts

Gets the NumActiveParts.

Property NumParts

Gets the NumParts.

Property PointMasses

Gets the PointMasses.

Property Prototypes

Gets the Prototypes.

Property SurfaceArea

Gets the SurfaceArea.

Property UseCADAssociativity

Gets the UseCADAssociativity.

Property UseCADAttribTrans

Gets the UseCADAttribTrans.

Property UseCADNamedSelTrans

Gets the UseCADNamedSelTrans.

Property Volume

Gets the Volume.

Property XCentroid

Gets the XCentroid.

Property YCentroid

Gets the YCentroid.

Property ZCentroid

Gets the ZCentroid.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Method AddPointMass()

Creates a new child PointMass.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

101

Ansys.ACT.Automation.Mechanical Namespace

BoundingBoxLengthX
Gets the BoundingBoxLengthX.

Declaration Syntax
public Quantity BoundingBoxLengthX { get; }

BoundingBoxLengthY
Gets the BoundingBoxLengthY.

Declaration Syntax
public Quantity BoundingBoxLengthY { get; }

BoundingBoxLengthZ
Gets the BoundingBoxLengthZ.

Declaration Syntax
public Quantity BoundingBoxLengthZ { get; }

CADAttribPrefixes
Gets the CADAttribPrefixes.

Declaration Syntax
public string CADAttribPrefixes { get; }

CADFile
Gets the CADFile.

Declaration Syntax
public string CADFile { get; }

CADNamedSelPrefixes
Gets the CADNamedSelPrefixes.

Declaration Syntax
public string CADNamedSelPrefixes { get; }

CanChangeCADUnits
Gets the CanChangeCADUnits.

102

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PrototypeGroup

Declaration Syntax
public bool CanChangeCADUnits { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DoSmartUpdate
Gets the DoSmartUpdate.

Declaration Syntax
public bool DoSmartUpdate { get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

FiberLength
Gets the FiberLength.

Declaration Syntax
public Quantity FiberLength { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

103

Ansys.ACT.Automation.Mechanical Namespace

GeometryPreferencesReadOnly
Gets the GeometryPreferencesReadOnly.

Declaration Syntax
public bool GeometryPreferencesReadOnly { get; }

GeometryType
Gets the GeometryType.

Declaration Syntax
public GeometryType GeometryType { get; }

ImportCoordinateSystems
Gets the ImportCoordinateSystems.

Declaration Syntax
public bool ImportCoordinateSystems { get; }

ImportEnclosureAndSymmetry
Gets the ImportEnclosureAndSymmetry.

Declaration Syntax
public bool ImportEnclosureAndSymmetry { get; }

ImportSheets
Gets the ImportSheets.

Declaration Syntax
public bool ImportSheets { get; }

ImportSolids
Gets the ImportSolids.

Declaration Syntax
public bool ImportSolids { get; }

ImportWires
Gets the ImportWires.

104

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PrototypeGroup

Declaration Syntax
public bool ImportWires { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

MeshVolume
Gets the MeshVolume.

Declaration Syntax
public Quantity MeshVolume { get; }

Model2DBehavior
Gets or sets the Model2DBehavior.

Declaration Syntax
public Model2DBehavior Model2DBehavior { set;get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

NumActiveParts
Gets the NumActiveParts.

Declaration Syntax
public int NumActiveParts { get; }

NumParts
Gets the NumParts.

Declaration Syntax
public int NumParts { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

105

Ansys.ACT.Automation.Mechanical Namespace

PointMasses
Gets the PointMasses.

Declaration Syntax
public IEnumerable<PointMass> PointMasses { get; }

Prototypes
Gets the Prototypes.

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

SurfaceArea
Gets the SurfaceArea.

Declaration Syntax
public Quantity SurfaceArea { get; }

UseCADAssociativity
Gets the UseCADAssociativity.

Declaration Syntax
public bool UseCADAssociativity { get; }

UseCADAttribTrans
Gets the UseCADAttribTrans.

Declaration Syntax
public bool UseCADAttribTrans { get; }

UseCADNamedSelTrans
Gets the UseCADNamedSelTrans.

Declaration Syntax
public bool UseCADNamedSelTrans { get; }

Volume
Gets the Volume.

106

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PrototypeGroup

Declaration Syntax
public Quantity Volume { get; }

XCentroid
Gets the XCentroid.

Declaration Syntax
public Quantity XCentroid { get; }

YCentroid
Gets the YCentroid.

Declaration Syntax
public Quantity YCentroid { get; }

ZCentroid
Gets the ZCentroid.

Declaration Syntax
public Quantity ZCentroid { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

AddPointMass()
Creates a new child PointMass.

Declaration Syntax
public PointMass AddPointMass()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

107

Ansys.ACT.Automation.Mechanical Namespace

RemotePoint
Defines a RemotePoint.

Declaration Syntax
public class RemotePoint : DataModelObject, ISelectionInfo
Table 59: Members
Property Behavior

Gets or sets the Behavior.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property ComponentXActiveOrInactive Gets or sets the ComponentXActiveOrInactive.


Property ComponentYActiveOrInactive

Gets or sets the ComponentYActiveOrInactive.

Property ComponentZActiveOrInactive Gets or sets the ComponentZActiveOrInactive.


Property CoordinateSystem

Gets or sets the CoordinateSystem.

Property DOFSelection

Gets or sets the DOFSelection.

Property GloballyAvailable

Gets or sets the GloballyAvailable.

Property LocationX

Gets or sets the LocationX.

Property LocationY

Gets or sets the LocationY.

Property LocationZ

Gets or sets the LocationZ.

Property PinballSize

Gets or sets the PinballSize.

Property RotationXActiveOrInactive

Gets or sets the RotationXActiveOrInactive.

Property RotationYActiveOrInactive

Gets or sets the RotationYActiveOrInactive.

Property RotationZActiveOrInactive

Gets or sets the RotationZActiveOrInactive.

Property Scope

Gets or sets the Scope.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method GetMeshRegion()

Returns the mesh region associated to the remote


point.

Behavior
Gets or sets the Behavior.

Declaration Syntax
public LoadBehaviorType Behavior { set;get; }

Children
Gets the list of children.

108

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

RemotePoint

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ComponentXActiveOrInactive
Gets or sets the ComponentXActiveOrInactive.

Declaration Syntax
public ActiveInactive ComponentXActiveOrInactive { set;get; }

ComponentYActiveOrInactive
Gets or sets the ComponentYActiveOrInactive.

Declaration Syntax
public ActiveInactive ComponentYActiveOrInactive { set;get; }

ComponentZActiveOrInactive
Gets or sets the ComponentZActiveOrInactive.

Declaration Syntax
public ActiveInactive ComponentZActiveOrInactive { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public ICoordinateSystem CoordinateSystem { set;get; }

DOFSelection
Gets or sets the DOFSelection.

Declaration Syntax
public DOFSelectionType DOFSelection { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

109

Ansys.ACT.Automation.Mechanical Namespace

GloballyAvailable
Gets or sets the GloballyAvailable.

Declaration Syntax
public bool GloballyAvailable { set;get; }

LocationX
Gets or sets the LocationX.

Declaration Syntax
public Quantity LocationX { set;get; }

LocationY
Gets or sets the LocationY.

Declaration Syntax
public Quantity LocationY { set;get; }

LocationZ
Gets or sets the LocationZ.

Declaration Syntax
public Quantity LocationZ { set;get; }

PinballSize
Gets or sets the PinballSize.

Declaration Syntax
public Quantity PinballSize { set;get; }

RotationXActiveOrInactive
Gets or sets the RotationXActiveOrInactive.

Declaration Syntax
public ActiveInactive RotationXActiveOrInactive { set;get; }

RotationYActiveOrInactive
Gets or sets the RotationYActiveOrInactive.

110

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

RemotePointGroup

Declaration Syntax
public ActiveInactive RotationYActiveOrInactive { set;get; }

RotationZActiveOrInactive
Gets or sets the RotationZActiveOrInactive.

Declaration Syntax
public ActiveInactive RotationZActiveOrInactive { set;get; }

Scope
Gets or sets the Scope.

Declaration Syntax
public ISelectionInfo Scope { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

GetMeshRegion()
Returns the mesh region associated to the remote point.

Declaration Syntax
public IMeshRegion GetMeshRegion()

RemotePointGroup
Defines a RemotePointGroup.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

111

Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class RemotePointGroup : DataModelObject
Table 60: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property RemotePoints

Gets the RemotePoints.

Property ShowLines

Gets or sets the ShowLines.

Method AddComment()

Creates a new child Comment.

Method AddRemotePoint() Creates a new child


RemotePoint.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

RemotePoints
Gets the RemotePoints.

Declaration Syntax
public IEnumerable<RemotePoint> RemotePoints { get; }

ShowLines
Gets or sets the ShowLines.

Declaration Syntax
public bool ShowLines { set;get; }

AddComment()
Creates a new child Comment.

112

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Solution

Declaration Syntax
public Comment AddComment()

AddRemotePoint()
Creates a new child RemotePoint.

Declaration Syntax
public RemotePoint AddRemotePoint()

Solution
Defines a Solution.

Declaration Syntax
public class Solution : DataModelObject
Table 61: Members
Property CellId

Gets the CellId.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Figures

Gets the list of associated


figures.

Property Results

Gets the Results.

Property WorkingDir

Gets the WorkingDir.

Method AddComment()

Creates a new child Comment.

Method AddDeformation() Creates a new child


Deformation.
Method AddFigure()

Creates a new child Figure.

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

Declaration Syntax
public IEnumerable<DataModelObject> Children { get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

113

Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Results
Gets the Results.

Declaration Syntax
public IEnumerable<Result> Results { get; }

WorkingDir
Gets the WorkingDir.

Declaration Syntax
public string WorkingDir { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddDeformation()
Creates a new child Deformation.

Declaration Syntax
public Deformation AddDeformation()

AddFigure()
Creates a new child Figure.

114

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Solution

Declaration Syntax
public Figure AddFigure()

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

115

116

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.Mechanical.Results Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results
Table 62: Members
Deformation Defines a
Deformation.
Result

Defines a Result.

Deformation
Defines a Deformation.

Declaration Syntax
public class Deformation : Result
Table 63: Members
Property CalculateTimeHistory Gets or sets the
CalculateTimeHistory.
(Inherited from Result.)
Property Children

Gets the list of children.


(Inherited from Result.)

Property Comments

Gets the list of associated


comments.
(Inherited from Result.)

Property DisplayTime

Gets or sets the DisplayTime.


(Inherited from Result.)

Property Figures

Gets the list of associated


figures.
(Inherited from Result.)

Property GeometrySelection

Gets or sets the


GeometrySelection.
(Inherited from Result.)

Property Identifier

Gets or sets the Identifier.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

117

Ansys.ACT.Automation.Mechanical.Results Namespace
(Inherited from Result.)
Property Maximum

Gets the Maximum.

Property Minimum

Gets the Minimum.

Property SetDriver

Gets or sets the SetDriver.


(Inherited from Result.)

Property Suppressed

Gets or sets the Suppressed.


(Inherited from Result.)

Property Type

Gets or sets the Type.

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

Type
Gets or sets the Type.

Declaration Syntax
public DeformationType Type { set;get; }

Result
Defines a Result.

Declaration Syntax
public class Result : DataModelObject
Table 64: Members
Property CalculateTimeHistory Gets or sets the
CalculateTimeHistory.
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

118

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Result
Property DisplayTime

Gets or sets the DisplayTime.

Property Figures

Gets the list of associated


figures.

Property GeometrySelection

Gets or sets the


GeometrySelection.

Property Identifier

Gets or sets the Identifier.

Property SetDriver

Gets or sets the SetDriver.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

CalculateTimeHistory
Gets or sets the CalculateTimeHistory.

Declaration Syntax
public bool CalculateTimeHistory { set;get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DisplayTime
Gets or sets the DisplayTime.

Declaration Syntax
public double DisplayTime { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

119

Ansys.ACT.Automation.Mechanical.Results Namespace

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

Identifier
Gets or sets the Identifier.

Declaration Syntax
public string Identifier { set;get; }

SetDriver
Gets or sets the SetDriver.

Declaration Syntax
public SetDriverStyle SetDriver { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

120

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.Mechanical.Enums Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Enums
Table 65: Members
ActiveInactive

Specifies the ActiveInactive.

AutoDetectionType

Specifies the AutoDetectionType.

AutoOrManual

Specifies the AutoOrManual.

CommandEditorTarget

Specifies the CommandEditorTarget.

CondensedPartInterfaceMethod

Specifies the
CondensedPartInterfaceMethod.

CondensedPartPhysics

Specifies the CondensedPartPhysics.

CondensedPartReductionMethod

Specifies the
CondensedPartReductionMethod.

ConnectionScopingType

Specifies the ConnectionScopingType.

ContactBehavior

Specifies the ContactBehavior.

ContactCorrection

Specifies the ContactCorrection.

ContactDetectionPoint

Specifies the ContactDetectionPoint.

ContactEdgeEdgeOption

Specifies the ContactEdgeEdgeOption.

ContactElasticSlipToleranceType

Specifies the
ContactElasticSlipToleranceType.

ContactFaceEdgeOption

Specifies the ContactFaceEdgeOption.

ContactFaceEdgePriority

Specifies the ContactFaceEdgePriority.

ContactFormulationType

Specifies the ContactFormulationType.

ContactGroupingType

Specifies the ContactGroupingType.

ContactInitialEffect

Specifies the ContactInitialEffect.

ContactOrientation

Specifies the ContactOrientation.

ContactPenetrationToleranceType

Specifies the
ContactPenetrationToleranceType.

ContactPinballType

Specifies the ContactPinballType.

ContactSearchingType

Specifies the ContactSearchingType.

ContactToleranceType

Specifies the ContactToleranceType.

ContactTrimType

Specifies the ContactTrimType.

ContactType

Specifies the ContactType.

ContectDetection

Specifies the ContectDetection.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

121

Ansys.ACT.Automation.Mechanical.Enums Namespace
CoordinateSystemType

Specifies the CoordinateSystemType.

CrossSectionType

Specifies the CrossSectionType.

DeformationType

Specifies the DeformationType.

DistributedMassInputType

Specifies the DistributedMassInputType.

DOFSelectionType

Specifies the DOFSelectionType.

FutureIntent

Specifies the FutureIntent.

GeometryDefineByType

Specifies the GeometryDefineByType.

GeometryType

Specifies the GeometryType.

JointInitialPosition

Specifies the JointInitialPosition.

JointScopingType

Specifies the JointScopingType.

JointSolverElementType

Specifies the JointSolverElementType.

JointStopType

Specifies the JointStopType.

JointType

Specifies the JointType.

LoadBehaviorType

Specifies the LoadBehaviorType.

MeshDisplayStyle

Specifies the MeshDisplayStyle.

Model2DBehavior

Specifies the Model2DBehavior.

PathScoping

Specifies the PathScoping.

RemoteApplicationType

Specifies the RemoteApplicationType.

RotationPlane

Specifies the RotationPlane.

SetDriverStyle

Specifies the SetDriverStyle.

SpringBehavior

Specifies the SpringBehavior.

SpringPreloadType

Specifies the SpringPreloadType.

SpringResultType

Specifies the SpringResultType.

SpringScopingType

Specifies the SpringScopingType.

SpringStiffnessType

Specifies the SpringStiffnessType.

SpringType

Specifies the SpringType.

StiffnessBehavior

Specifies the StiffnessBehavior.

TargetCorrection

Specifies the TargetCorrection.

TargetOrientation

Specifies the TargetOrientation.

ToleranceType

Specifies the ToleranceType.

UpdateContactStiffness

Specifies the UpdateContactStiffness.

ActiveInactive
Specifies the ActiveInactive.

122

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CommandEditorTarget

Declaration Syntax
public enum ActiveInactive
Table 66: Members
Member Active Active.
Member Inactive Inactive.

AutoDetectionType
Specifies the AutoDetectionType.

Declaration Syntax
public enum AutoDetectionType
Table 67: Members
Member Contact

Contact.

Member Joint

Joint.

Member MeshConnection MeshConnection.

AutoOrManual
Specifies the AutoOrManual.

Declaration Syntax
public enum AutoOrManual
Table 68: Members
Member Automatic Automatic.
Member Manual

Manual.

CommandEditorTarget
Specifies the CommandEditorTarget.

Declaration Syntax
public enum CommandEditorTarget
Table 69: Members
Member ABAQUS

ABAQUS.

Member ANSYS

ANSYS.

Member LSDYNA

LSDYNA.

Member MBD

MBD.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

123

Ansys.ACT.Automation.Mechanical.Enums Namespace
Member SAMCEF

SAMCEF.

Member UNKNOWN UNKNOWN.

CondensedPartInterfaceMethod
Specifies the CondensedPartInterfaceMethod.

Declaration Syntax
public enum CondensedPartInterfaceMethod
Table 70: Members
Member Fixed

Fixed.

Member Free

Free.

Member ResidualFlexibleFree ResidualFlexibleFree.

CondensedPartPhysics
Specifies the CondensedPartPhysics.

Declaration Syntax
public enum CondensedPartPhysics
Table 71: Members
Member Structural Structural.
Member Thermal Thermal.

CondensedPartReductionMethod
Specifies the CondensedPartReductionMethod.

Declaration Syntax
public enum CondensedPartReductionMethod
Table 72: Members
Member CMS

CMS.

Member Guyan Guyan.

ConnectionScopingType
Specifies the ConnectionScopingType.

124

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactDetectionPoint

Declaration Syntax
public enum ConnectionScopingType
Table 73: Members
Member BodyToBody

BodyToBody.

Member BodyToGround BodyToGround.

ContactBehavior
Specifies the ContactBehavior.

Declaration Syntax
public enum ContactBehavior
Table 74: Members
Member Asymmetric

Asymmetric.

Member AutoAsymmetric

AutoAsymmetric.

Member ProgramControlled ProgramControlled.


Member Symmetric

Symmetric.

ContactCorrection
Specifies the ContactCorrection.

Declaration Syntax
public enum ContactCorrection
Table 75: Members
Member Bolt

Bolt.

Member No

No.

Member Smoothing Smoothing.

ContactDetectionPoint
Specifies the ContactDetectionPoint.

Declaration Syntax
public enum ContactDetectionPoint
Table 76: Members
Member NodalNormalFromContact

NodalNormalFromContact.

Member NodalNormalToTarget

NodalNormalToTarget.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

125

Ansys.ACT.Automation.Mechanical.Enums Namespace
Member NodalProjectedNormalFromContact NodalProjectedNormalFromContact.
Member OnGaussPoint

OnGaussPoint.

Member ProgramControlled

ProgramControlled.

ContactEdgeEdgeOption
Specifies the ContactEdgeEdgeOption.

Declaration Syntax
public enum ContactEdgeEdgeOption
Table 77: Members
Member IfNoEdgeFace IfNoEdgeFace.
Member No

No.

Member Yes

Yes.

ContactElasticSlipToleranceType
Specifies the ContactElasticSlipToleranceType.

Declaration Syntax
public enum ContactElasticSlipToleranceType
Table 78: Members
Member Factor

Factor.

Member ProgramControlled ProgramControlled.


Member Value

Value.

ContactFaceEdgeOption
Specifies the ContactFaceEdgeOption.

Declaration Syntax
public enum ContactFaceEdgeOption
Table 79: Members
Member IfNoFaceFace

IfNoFaceFace.

Member No

No.

Member OnlySolidEdges

OnlySolidEdges.

Member OnlySurfaceEdges OnlySurfaceEdges.


Member Yes

126

Yes.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactGroupingType

ContactFaceEdgePriority
Specifies the ContactFaceEdgePriority.

Declaration Syntax
public enum ContactFaceEdgePriority
Table 80: Members
Member EdgeOverFace EdgeOverFace.
Member FaceOverEdge FaceOverEdge.
Member IncludeAll

IncludeAll.

ContactFormulationType
Specifies the ContactFormulationType.

Declaration Syntax
public enum ContactFormulationType
Table 81: Members
Member AugmentedLagrange AugmentedLagrange.
Member Beam

Beam.

Member Lagrange

Lagrange.

Member MPC

MPC.

Member ProgramControlled

ProgramControlled.

Member PureLagrange

PureLagrange.

Member PurePenalty

PurePenalty.

ContactGroupingType
Specifies the ContactGroupingType.

Declaration Syntax
public enum ContactGroupingType
Table 82: Members
Member ByBodies ByBodies.
Member ByFaces ByFaces.
Member ByParts

ByParts.

Member None

None.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

127

Ansys.ACT.Automation.Mechanical.Enums Namespace

ContactInitialEffect
Specifies the ContactInitialEffect.

Declaration Syntax
public enum ContactInitialEffect
Table 83: Members
Member cifINCLUDE_GAP_PEonOffset

cifINCLUDE_GAP_PEonOffset.

Member IncludeGapPenetrationOffsetNoRamped IncludeGapPenetrationOffsetNoRamped.


Member IncludeGapPenetrationOffsetRamped

IncludeGapPenetrationOffsetRamped.

Member IncludeOffset

IncludeOffset.

Member IncludeOffsetRamped

IncludeOffsetRamped.

Member None

None.

ContactOrientation
Specifies the ContactOrientation.

Declaration Syntax
public enum ContactOrientation
Table 84: Members
Member Circle

Circle.

Member Cylinder

Cylinder.

Member ProgramControlled ProgramControlled.


Member Sphere

Sphere.

ContactPenetrationToleranceType
Specifies the ContactPenetrationToleranceType.

Declaration Syntax
public enum ContactPenetrationToleranceType
Table 85: Members
Member Factor

Factor.

Member ProgramControlled ProgramControlled.


Member Value

Value.

ContactPinballType
Specifies the ContactPinballType.

128

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactTrimType

Declaration Syntax
public enum ContactPinballType
Table 86: Members
Member AutoDetectionValue AutoDetectionValue.
Member Factor

Factor.

Member ProgramControlled ProgramControlled.


Member Radius

Radius.

ContactSearchingType
Specifies the ContactSearchingType.

Declaration Syntax
public enum ContactSearchingType
Table 87: Members
Member AcrossAssemblies AcrossAssemblies.
Member AcrossBodies

AcrossBodies.

Member AcrossParts

AcrossParts.

Member Anywhere

Anywhere.

ContactToleranceType
Specifies the ContactToleranceType.

Declaration Syntax
public enum ContactToleranceType
Table 88: Members
Member SheetThickness SheetThickness.
Member Slider

Slider.

Member Value

Value.

ContactTrimType
Specifies the ContactTrimType.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

129

Ansys.ACT.Automation.Mechanical.Enums Namespace

Declaration Syntax
public enum ContactTrimType
Table 89: Members
Member FaceBased

FaceBased.

Member Off

Off.

Member On

On.

Member ProgramControlled ProgramControlled.

ContactType
Specifies the ContactType.

Declaration Syntax
public enum ContactType
Table 90: Members
Member Bonded

Bonded.

Member BondedInitial

BondedInitial.

Member ForcedFrictionalSliding ForcedFrictionalSliding.


Member Frictional

Frictional.

Member Frictionless

Frictionless.

Member GeneralWeld

GeneralWeld.

Member NoSeparation

NoSeparation.

Member NoSeparationSliding

NoSeparationSliding.

Member Reinforcement

Reinforcement.

Member Rough

Rough.

Member SpotWeld

SpotWeld.

Member Unknown

Unknown.

ContectDetection
Specifies the ContectDetection.

Declaration Syntax
public enum ContectDetection
Table 91: Members
Member ProximityBased ProximityBased.
Member Trajectory

130

Trajectory.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

DistributedMassInputType

CoordinateSystemType
Specifies the CoordinateSystemType.

Declaration Syntax
public enum CoordinateSystemType
Table 92: Members
Member Cartesian Cartesian.
Member Cylindrical Cylindrical.
Member Spherical Spherical.

CrossSectionType
Specifies the CrossSectionType.

Declaration Syntax
public enum CrossSectionType
Table 93: Members
Member Circular Circular.

DeformationType
Specifies the DeformationType.

Declaration Syntax
public enum DeformationType
Table 94: Members
Member Directional Directional.
Member Total

Total.

DistributedMassInputType
Specifies the DistributedMassInputType.

Declaration Syntax
public enum DistributedMassInputType
Table 95: Members
Member MassPerUnitArea MassPerUnitArea.
Member TotalMass

TotalMass.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

131

Ansys.ACT.Automation.Mechanical.Enums Namespace

DOFSelectionType
Specifies the DOFSelectionType.

Declaration Syntax
public enum DOFSelectionType
Table 96: Members
Member Automatic Automatic.
Member Manual

Manual.

FutureIntent
Specifies the FutureIntent.

Declaration Syntax
public enum FutureIntent
Table 97: Members
Member SaveFilesForHarmonicAnalysis

SaveFilesForHarmonicAnalysis.

Member SaveFilesForModeSuperpositionAnalysis

SaveFilesForModeSuperpositionAnalysis.

Member SaveFilesForPrestressedFullHarmonicAnalysis

SaveFilesForPrestressedFullHarmonicAnalysis.

Member SaveFilesForPrestressedModalAnalysis

SaveFilesForPrestressedModalAnalysis.

Member SaveFilesForPreStressModeSuperpositionAnalysis SaveFilesForPreStressModeSuperpositionAnalysis.


Member SaveFilesForPSDAnalysis

SaveFilesForPSDAnalysis.

Member SaveFilesForRBDTransientAnalysis

SaveFilesForRBDTransientAnalysis.

Member SaveFilesForRSAnalysis

SaveFilesForRSAnalysis.

Member SaveFilesForTransientAnalysis

SaveFilesForTransientAnalysis.

Member SaveNone

SaveNone.

Member SaveRestartFiles

SaveRestartFiles.

GeometryDefineByType
Specifies the GeometryDefineByType.

Declaration Syntax
public enum GeometryDefineByType
Table 98: Members
Member AnalysisPly

AnalysisPly.

Member Component

Component.

Member Coordinates

Coordinates.

132

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

JointScopingType
Member Fracture

Fracture.

Member Geometry

Geometry.

Member ImportedAssembly ImportedAssembly.


Member ImportedInterface ImportedInterface.
Member Mapping

Mapping.

Member MaxValues

MaxValues.

Member MinValues

MinValues.

Member Path

Path.

Member RemotePoint

RemotePoint.

Member Surface

Surface.

Member Worksheet

Worksheet.

GeometryType
Specifies the GeometryType.

Declaration Syntax
public enum GeometryType
Table 99: Members
Member Empty

Empty.

Member Lightweight Lightweight.


Member Mixed

Mixed.

Member Sheet

Sheet.

Member Solid

Solid.

Member Unknown

Unknown.

Member Wire

Wire.

JointInitialPosition
Specifies the JointInitialPosition.

Declaration Syntax
public enum JointInitialPosition
Table 100: Members
Member Override

Override.

Member Unchanged Unchanged.

JointScopingType
Specifies the JointScopingType.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

133

Ansys.ACT.Automation.Mechanical.Enums Namespace

Declaration Syntax
public enum JointScopingType
Table 101: Members
Member BodyToBody

BodyToBody.

Member BodyToGround BodyToGround.

JointSolverElementType
Specifies the JointSolverElementType.

Declaration Syntax
public enum JointSolverElementType
Table 102: Members
Member ContactDirect

ContactDirect.

Member Element

Element.

Member ProgramControlled ProgramControlled.

JointStopType
Specifies the JointStopType.

Declaration Syntax
public enum JointStopType
Table 103: Members
Member Lock Lock.
Member None None.
Member Stop Stop.

JointType
Specifies the JointType.

Declaration Syntax
public enum JointType
Table 104: Members
Member Bushing

Bushing.

Member Cylindrical

Cylindrical.

Member Fixed

Fixed.

134

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshDisplayStyle
Member Gneral

Gneral.

Member Planar

Planar.

Member PlaneRadialGap PlaneRadialGap.


Member PointOnCurve PointOnCurve.
Member RadialGap3D

RadialGap3D.

Member Revolute

Revolute.

Member Slot

Slot.

Member Spherical

Spherical.

Member SphericalGap

SphericalGap.

Member Translational

Translational.

Member Universal

Universal.

LoadBehaviorType
Specifies the LoadBehaviorType.

Declaration Syntax
public enum LoadBehaviorType
Table 105: Members
Member Beam

Beam.

Member Coupled

Coupled.

Member Deformable Deformable.


Member Rigid

Rigid.

MeshDisplayStyle
Specifies the MeshDisplayStyle.

Declaration Syntax
public enum MeshDisplayStyle
Table 106: Members
Member AspectRatio

AspectRatio.

Member BodyColor

BodyColor.

Member ElementQuality

ElementQuality.

Member JacobianRatio

JacobianRatio.

Member MaximumCornerAngle MaximumCornerAngle.


Member OrthogonalQuality

OrthogonalQuality.

Member ParallelDeviation

ParallelDeviation.

Member ShellThickness

ShellThickness.

Member Skewness

Skewness.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

135

Ansys.ACT.Automation.Mechanical.Enums Namespace
Member WarpingFactor

WarpingFactor.

Model2DBehavior
Specifies the Model2DBehavior.

Declaration Syntax
public enum Model2DBehavior
Table 107: Members
Member AxiSymmetric

AxiSymmetric.

Member ByBody

ByBody.

Member GeneralizedPlaneStrain GeneralizedPlaneStrain.


Member PlaneStrain

PlaneStrain.

Member PlaneStress

PlaneStress.

PathScoping
Specifies the PathScoping.

Declaration Syntax
public enum PathScoping
Table 108: Members
Member Edge Edge.
Member Points Points.
Member Ray

Ray.

RemoteApplicationType
Specifies the RemoteApplicationType.

Declaration Syntax
public enum RemoteApplicationType
Table 109: Members
Member DirectAttachment

DirectAttachment.

Member RemoteAttachment

RemoteAttachment.

Member UnknownAttachment UnknownAttachment.

RotationPlane
Specifies the RotationPlane.

136

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

SpringBehavior

Declaration Syntax
public enum RotationPlane
Table 110: Members
Member None None.
Member XY

XY.

Member XZ

XZ.

Member YZ

YZ.

SetDriverStyle
Specifies the SetDriverStyle.

Declaration Syntax
public enum SetDriverStyle
Table 111: Members
Member CyclicPhaseOfMax CyclicPhaseOfMax.
Member MaxOfCyclicPhase MaxOfCyclicPhase.
Member MaxOverModes

MaxOverModes.

Member MaxOverPhase

MaxOverPhase.

Member MaxOverTime

MaxOverTime.

Member ModeOfMax

ModeOfMax.

Member PhaseOfMax

PhaseOfMax.

Member ResultSet

ResultSet.

Member Time

Time.

Member TimeOfMax

TimeOfMax.

Member Undefined

Undefined.

SpringBehavior
Specifies the SpringBehavior.

Declaration Syntax
public enum SpringBehavior
Table 112: Members
Member Linear

Linear.

Member NonLinear

NonLinear.

Member NonLinearCompressionOnly NonLinearCompressionOnly.


Member NonLinearTensionOnly

NonLinearTensionOnly.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

137

Ansys.ACT.Automation.Mechanical.Enums Namespace

SpringPreloadType
Specifies the SpringPreloadType.

Declaration Syntax
public enum SpringPreloadType
Table 113: Members
Member Length Length.
Member Load

Load.

Member None

None.

Member Rotation Rotation.


Member Torque Torque.

SpringResultType
Specifies the SpringResultType.

Declaration Syntax
public enum SpringResultType
Table 114: Members
Member DampingForce DampingForce.
Member ElasticForce

ElasticForce.

Member Elongation

Elongation.

Member Velocity

Velocity.

SpringScopingType
Specifies the SpringScopingType.

Declaration Syntax
public enum SpringScopingType
Table 115: Members
Member BodyToBody

BodyToBody.

Member BodyToGround BodyToGround.

SpringStiffnessType
Specifies the SpringStiffnessType.

138

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

TargetCorrection

Declaration Syntax
public enum SpringStiffnessType
Table 116: Members
Member Factor

Factor.

Member Manual

Manual.

Member ProgramControlled ProgramControlled.

SpringType
Specifies the SpringType.

Declaration Syntax
public enum SpringType
Table 117: Members
Member Longitudinal Longitudinal.
Member Torsional

Torsional.

StiffnessBehavior
Specifies the StiffnessBehavior.

Declaration Syntax
public enum StiffnessBehavior
Table 118: Members
Member Beam

Beam.

Member Flexible

Flexible.

Member Gasket

Gasket.

Member Rigid

Rigid.

Member RigidBeam

RigidBeam.

Member Superelement Superelement.

TargetCorrection
Specifies the TargetCorrection.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

139

Ansys.ACT.Automation.Mechanical.Enums Namespace

Declaration Syntax
public enum TargetCorrection
Table 119: Members
Member No

No.

Member Smoothing Smoothing.

TargetOrientation
Specifies the TargetOrientation.

Declaration Syntax
public enum TargetOrientation
Table 120: Members
Member Circle

Circle.

Member Cylinder

Cylinder.

Member ProgramControlled ProgramControlled.


Member Sphere

Sphere.

ToleranceType
Specifies the ToleranceType.

Declaration Syntax
public enum ToleranceType
Table 121: Members
Member Manual

Manual.

Member ProgramControlled ProgramControlled.

UpdateContactStiffness
Specifies the UpdateContactStiffness.

Declaration Syntax
public enum UpdateContactStiffness
Table 122: Members
Member EachEquilibriumIteration

EachEquilibriumIteration.

Member EachEquilibriumIterationAggressive EachEquilibriumIterationAggressive.


Member EachSubStep

140

EachSubStep.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

UpdateContactStiffness
Member Never

Never.

Member ProgramControlled

ProgramControlled.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

141

142

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.AAP.DesignModeler.Primitives.Sheet Namespace
Declaration Syntax
namespace Ansys.AAP.DesignModeler.Primitives.Sheet
Table 123: Members
Cylinder Cylinder
Class

Cylinder
Cylinder Class

Declaration Syntax
public class Cylinder : Primitive, ISheetCylinder
Table 124: Members
Constructor Cylinder(GeometryBuilder,
IEnumerable<double>,
IEnumerable<double>, double)

Create a new Cylinder.

Property

Center

Gets or sets the center of the cylinder.

Property

Direction

Gets or sets the axis of the cylinder.

Property

Radius

Gets or sets the radius of the cylinder.

Method

Generate()

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)

Parameters
builder(GeometryBuilder)
No details are provided for this entry.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

143

Ansys.AAP.DesignModeler.Primitives.Sheet Namespace
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()

144

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.Mechanical.MeshControls Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.MeshControls
Table 125: Members
ContactSizingMeshControl Defines a
ContactSizingMeshControl.
FaceMeshingMeshControl

Defines a
FaceMeshingMeshControl.

InflationMeshControl

Defines a
InflationMeshControl.

MatchMeshControl

Defines a MatchMeshControl.

MeshControl

Defines a MeshControl.

MethodMeshControl

Defines a MethodMeshControl.

PinchMeshControl

Defines a PinchMeshControl.

RefinementMeshControl

Defines a
RefinementMeshControl.

SizingMeshControl

Defines a SizingMeshControl.

ContactSizingMeshControl
Defines a ContactSizingMeshControl.

Declaration Syntax
public class ContactSizingMeshControl : MeshControl
Table 126: Members
Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property ContactRegion Gets or sets the ContactRegion.


Property ElementSize

Gets or sets the ElementSize.

Property Figures

Gets the list of associated


figures.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

145

Ansys.ACT.Automation.Mechanical.MeshControls Namespace
(Inherited from MeshControl.)
Property Relevance

Gets or sets the Relevance.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

Property Type

Gets or sets the Type.

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

ElementSize
Gets or sets the ElementSize.

Declaration Syntax
public Quantity ElementSize { set;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; }

FaceMeshingMeshControl
Defines a FaceMeshingMeshControl.

Declaration Syntax
public class FaceMeshingMeshControl : MeshControl
Table 127: Members
Property Children

Gets the list of children.


(Inherited from MeshControl.)

146

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

FaceMeshingMeshControl
Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property ConstrainBoundary

Gets or sets the


ConstrainBoundary.

Property Figures

Gets the list of associated


figures.
(Inherited from MeshControl.)

Property GeometrySelection

Gets or sets the


GeometrySelection.

Property MappedMeshOption Gets or sets the


MappedMeshOption.
Property Method

Gets the Method.

Property NumberOfDivisions

Gets or sets the


NumberOfDivisions.

Property SpecifiedCorners

Gets or sets the


SpecifiedCorners.

Property SpecifiedEnds

Gets or sets the SpecifiedEnds.

Property SpecifiedSides

Gets or sets the SpecifiedSides.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

ConstrainBoundary
Gets or sets the ConstrainBoundary.

Declaration Syntax
public int ConstrainBoundary { set;get; }

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

MappedMeshOption
Gets or sets the MappedMeshOption.

Declaration Syntax
public YesNo MappedMeshOption { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

147

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Method
Gets the Method.

Declaration Syntax
public int Method { get; }

NumberOfDivisions
Gets or sets the NumberOfDivisions.

Declaration Syntax
public int NumberOfDivisions { 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; }

InflationMeshControl
Defines a InflationMeshControl.

Declaration Syntax
public class InflationMeshControl : MeshControl
Table 128: Members
Property Boundary

148

Gets or sets the list of


Boundary.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

InflationMeshControl
Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property Figures

Gets the list of associated


figures.
(Inherited from MeshControl.)

Property FirstLayerHeight

Gets or sets the


FirstLayerHeight.

Property GeometrySelection

Gets or sets the


GeometrySelection.

Property GrowthRate

Gets or sets the GrowthRate.

Property InflationAlgorithm

Gets or sets the


InflationAlgorithm.

Property InflationOption

Gets or sets the


InflationOption.

Property MaximumLayers

Gets or sets the


MaximumLayers.

Property MaximumThickness Gets or sets the


MaximumThickness.
Property NumLayers

Gets or sets the NumLayers.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

Property TransitionRatio

Gets or sets the TransitionRatio.

Boundary
Gets or sets the list of Boundary.

Declaration Syntax
public IList<ISelectionInfo> Boundary { set;get; }

FirstLayerHeight
Gets or sets the FirstLayerHeight.

Declaration Syntax
public Quantity FirstLayerHeight { set;get; }

GeometrySelection
Gets or sets the GeometrySelection.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

149

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public ISelectionInfo GeometrySelection { 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; }

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; }

NumLayers
Gets or sets the NumLayers.

Declaration Syntax
public int NumLayers { set;get; }

150

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MatchMeshControl

TransitionRatio
Gets or sets the TransitionRatio.

Declaration Syntax
public double TransitionRatio { set;get; }

MatchMeshControl
Defines a MatchMeshControl.

Declaration Syntax
public class MatchMeshControl : MeshControl
Table 129: Members
Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property ControlMessages

Gets the ControlMessages.

Property Figures

Gets the list of associated figures.


(Inherited from MeshControl.)

Property HighCoordinateSystem

Gets or sets the


HighCoordinateSystem.

Property HighGeometrySelection Gets or sets the


HighGeometrySelection.
Property LowCoordinateSystem

Gets or sets the


LowCoordinateSystem.

Property LowGeometrySelection

Gets or sets the


LowGeometrySelection.

Property RotationAxis

Gets or sets the RotationAxis.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

Property Transformation

Gets or sets the Transformation.

ControlMessages
Gets the ControlMessages.

Declaration Syntax
public bool ControlMessages { get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

151

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

HighCoordinateSystem
Gets or sets the HighCoordinateSystem.

Declaration Syntax
public ICoordinateSystem HighCoordinateSystem { set;get; }

HighGeometrySelection
Gets or sets the HighGeometrySelection.

Declaration Syntax
public ISelectionInfo HighGeometrySelection { set;get; }

LowCoordinateSystem
Gets or sets the LowCoordinateSystem.

Declaration Syntax
public ICoordinateSystem 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 ICoordinateSystem RotationAxis { set;get; }

Transformation
Gets or sets the Transformation.

Declaration Syntax
public int Transformation { set;get; }

MeshControl
Defines a MeshControl.

152

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MeshControl

Declaration Syntax
public class MeshControl : DataModelObject
Table 130: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Figures

Gets the list of associated


figures.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment() Creates a new child Comment.


Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

153

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

MethodMeshControl
Defines a MethodMeshControl.

Declaration Syntax
public class MethodMeshControl : MeshControl
Table 131: Members
Property Algorithm

Gets or sets the Algorithm.

Property ApproxNumElements

Gets or sets the ApproxNumElements.

Property BFCartCoordSys

Gets or sets the BFCartCoordSys.

Property BFCartSpacingOption

Gets the BFCartSpacingOption.

Property BFCartSubType

Gets the BFCartSubType.

Property BFCartTolerance

Gets the BFCartTolerance.

Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated comments.


(Inherited from MeshControl.)

Property ControlMessages

Gets the ControlMessages.

Property CurvatureNormalAngle

Gets or sets the CurvatureNormalAngle.

Property DefeaturingTolerance

Gets or sets the DefeaturingTolerance.

Property DefineDefeaturingTolerance Gets or sets the


DefineDefeaturingTolerance.
Property DefineType

Gets or sets the DefineType.

Property ElementMidsideNodes

Gets or sets the ElementMidsideNodes.

Property FeatureAngle

Gets or sets the FeatureAngle.

Property Figures

Gets the list of associated figures.


(Inherited from MeshControl.)

Property FreeFaceMeshType

Gets or sets the FreeFaceMeshType.

Property FreeMeshType

Gets or sets the FreeMeshType.

154

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MethodMeshControl
Property KeyPoints

Gets or sets the KeyPoints.

Property Location

Gets or sets the Location.

Property MappedMeshType

Gets or sets the MappedMeshType.

Property MaxElementSize

Gets or sets the MaxElementSize.

Property Method

Gets or sets the Method.

Property MethodElementOption

Gets the MethodElementOption.

Property MinEdgeSize

Gets the MinEdgeSize.

Property MinElementSize

Gets or sets the MinElementSize.

Property NDiv

Gets or sets the NDiv.

Property NumCellsAcrossGap

Gets or sets the NumCellsAcrossGap.

Property PreserveBoundaries

Gets or sets the PreserveBoundaries.

Property ProjectionFactor

Gets the ProjectionFactor.

Property Refinement

Gets or sets the Refinement.

Property ReuseBlocking

Gets or sets the ReuseBlocking.

Property SourceGeometry

Gets or sets the SourceGeometry.

Property SourceTargetSelection

Gets or sets the SourceTargetSelection.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

Property SurfaceMeshMethod

Gets or sets the SurfaceMeshMethod.

Property SweepBiasType

Gets or sets the SweepBiasType.

Property SweepBiasValue

Gets or sets the SweepBiasValue.

Property SweepEdges

Gets or sets the SweepEdges.

Property SweepElementSize

Gets or sets the SweepElementSize.

Property SweepESizeType

Gets or sets the SweepESizeType.

Property SweepSizeBehavior

Gets or sets the SweepSizeBehavior.

Property TargetGeometry

Gets or sets the TargetGeometry.

Property TetraGrowthRate

Gets or sets the TetraGrowthRate.

Property TetraTransition

Gets or sets the TetraTransition.

Property WriteICEMCFDFiles

Gets or sets the WriteICEMCFDFiles.

Algorithm
Gets or sets the Algorithm.

Declaration Syntax
public MeshMethodAlgorithm Algorithm { set;get; }

ApproxNumElements
Gets or sets the ApproxNumElements.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

155

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public uint ApproxNumElements { set;get; }

BFCartCoordSys
Gets or sets the BFCartCoordSys.

Declaration Syntax
public ICoordinateSystem BFCartCoordSys { set;get; }

BFCartSpacingOption
Gets the BFCartSpacingOption.

Declaration Syntax
public int BFCartSpacingOption { get; }

BFCartSubType
Gets the BFCartSubType.

Declaration Syntax
public int BFCartSubType { get; }

BFCartTolerance
Gets the BFCartTolerance.

Declaration Syntax
public Quantity BFCartTolerance { get; }

ControlMessages
Gets the ControlMessages.

Declaration Syntax
public bool ControlMessages { get; }

CurvatureNormalAngle
Gets or sets the CurvatureNormalAngle.

Declaration Syntax
public Quantity CurvatureNormalAngle { set;get; }

156

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MethodMeshControl

DefeaturingTolerance
Gets or sets the DefeaturingTolerance.

Declaration Syntax
public Quantity DefeaturingTolerance { set;get; }

DefineDefeaturingTolerance
Gets or sets the DefineDefeaturingTolerance.

Declaration Syntax
public OnOff DefineDefeaturingTolerance { set;get; }

DefineType
Gets or sets the DefineType.

Declaration Syntax
public PatchIndependentDefineType DefineType { set;get; }

ElementMidsideNodes
Gets or sets the ElementMidsideNodes.

Declaration Syntax
public ElementMidsideNodesType ElementMidsideNodes { 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.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

157

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public int FreeMeshType { set;get; }

KeyPoints
Gets or sets the KeyPoints.

Declaration Syntax
public AutoOrManual KeyPoints { 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; }

MaxElementSize
Gets or sets the MaxElementSize.

Declaration Syntax
public Quantity MaxElementSize { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public MethodType Method { set;get; }

MethodElementOption
Gets the MethodElementOption.

Declaration Syntax
public int MethodElementOption { get; }

158

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MethodMeshControl

MinEdgeSize
Gets the MinEdgeSize.

Declaration Syntax
public Quantity MinEdgeSize { get; }

MinElementSize
Gets or sets the MinElementSize.

Declaration Syntax
public Quantity MinElementSize { set;get; }

NDiv
Gets or sets the NDiv.

Declaration Syntax
public int NDiv { set;get; }

NumCellsAcrossGap
Gets or sets the NumCellsAcrossGap.

Declaration Syntax
public int NumCellsAcrossGap { set;get; }

PreserveBoundaries
Gets or sets the PreserveBoundaries.

Declaration Syntax
public int PreserveBoundaries { set;get; }

ProjectionFactor
Gets the ProjectionFactor.

Declaration Syntax
public double ProjectionFactor { get; }

Refinement
Gets or sets the Refinement.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

159

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public int Refinement { set;get; }

ReuseBlocking
Gets or sets the ReuseBlocking.

Declaration Syntax
public OnOff ReuseBlocking { set;get; }

SourceGeometry
Gets or sets the SourceGeometry.

Declaration Syntax
public ISelectionInfo SourceGeometry { set;get; }

SourceTargetSelection
Gets or sets the SourceTargetSelection.

Declaration Syntax
public int SourceTargetSelection { 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; }

160

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MethodMeshControl

SweepEdges
Gets or sets the SweepEdges.

Declaration Syntax
public ISelectionInfo SweepEdges { set;get; }

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; }

SweepSizeBehavior
Gets or sets the SweepSizeBehavior.

Declaration Syntax
public int SweepSizeBehavior { set;get; }

TargetGeometry
Gets or sets the TargetGeometry.

Declaration Syntax
public ISelectionInfo TargetGeometry { set;get; }

TetraGrowthRate
Gets or sets the TetraGrowthRate.

Declaration Syntax
public double TetraGrowthRate { set;get; }

TetraTransition
Gets or sets the TetraTransition.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

161

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public int TetraTransition { set;get; }

WriteICEMCFDFiles
Gets or sets the WriteICEMCFDFiles.

Declaration Syntax
public bool WriteICEMCFDFiles { set;get; }

PinchMeshControl
Defines a PinchMeshControl.

Declaration Syntax
public class PinchMeshControl : MeshControl
Table 132: Members
Property AutoManualMode Gets the AutoManualMode.
Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property Figures

Gets the list of associated


figures.
(Inherited from MeshControl.)

Property MasterGeometry

Gets or sets the


MasterGeometry.

Property SlaveGeometry

Gets or sets the


SlaveGeometry.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

Property Tolerance

Gets or sets the Tolerance.

AutoManualMode
Gets the AutoManualMode.

Declaration Syntax
public int AutoManualMode { get; }

162

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

RefinementMeshControl

MasterGeometry
Gets or sets the MasterGeometry.

Declaration Syntax
public ISelectionInfo MasterGeometry { set;get; }

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; }

RefinementMeshControl
Defines a RefinementMeshControl.

Declaration Syntax
public class RefinementMeshControl : MeshControl
Table 133: Members
Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property Figures

Gets the list of associated


figures.
(Inherited from MeshControl.)

Property Location

Gets or sets the Location.

Property Refinement Gets or sets the Refinement.


Property Suppressed Gets or sets the Suppressed.
(Inherited from MeshControl.)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

163

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Refinement
Gets or sets the Refinement.

Declaration Syntax
public int Refinement { set;get; }

SizingMeshControl
Defines a SizingMeshControl.

Declaration Syntax
public class SizingMeshControl : MeshControl
Table 134: Members
Property Behavior

Gets or sets the Behavior.

Property BiasEdges

Gets or sets the BiasEdges.

Property BiasFactor

Gets or sets the BiasFactor.

Property BiasGrowthRate

Gets or sets the


BiasGrowthRate.

Property BiasOption

Gets or sets the BiasOption.

Property BiasType

Gets or sets the BiasType.

Property Children

Gets the list of children.


(Inherited from MeshControl.)

Property Comments

Gets the list of associated


comments.
(Inherited from MeshControl.)

Property CurvatureAngle

Gets or sets the


CurvatureAngle.

Property ElementSize

Gets or sets the ElementSize.

Property Figures

Gets the list of associated


figures.
(Inherited from MeshControl.)

Property GrowthRate

Gets or sets the GrowthRate.

Property LocalMinSize

Gets or sets the LocalMinSize.

164

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

SizingMeshControl
Property Location

Gets or sets the Location.

Property NumberOfDivisions Gets or sets the


NumberOfDivisions.
Property SphereCenter

Gets or sets the SphereCenter.

Property SphereCenterX

Gets the SphereCenterX.

Property SphereCenterY

Gets the SphereCenterY.

Property SphereCenterZ

Gets the SphereCenterZ.

Property SphereRadius

Gets or sets the SphereRadius.

Property Suppressed

Gets or sets the Suppressed.


(Inherited from MeshControl.)

Property Type

Gets or sets the Type.

Behavior
Gets or sets the Behavior.

Declaration Syntax
public SizingBehaviorType Behavior { set;get; }

BiasEdges
Gets or sets the BiasEdges.

Declaration Syntax
public ISelectionInfo BiasEdges { 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.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

165

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public BiasOptionType BiasOption { set;get; }

BiasType
Gets or sets the BiasType.

Declaration Syntax
public BiasType BiasType { set;get; }

CurvatureAngle
Gets or sets the CurvatureAngle.

Declaration Syntax
public Quantity CurvatureAngle { set;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; }

LocalMinSize
Gets or sets the LocalMinSize.

Declaration Syntax
public Quantity LocalMinSize { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

166

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

SizingMeshControl

NumberOfDivisions
Gets or sets the NumberOfDivisions.

Declaration Syntax
public int NumberOfDivisions { set;get; }

SphereCenter
Gets or sets the SphereCenter.

Declaration Syntax
public ICoordinateSystem SphereCenter { set;get; }

SphereCenterX
Gets the SphereCenterX.

Declaration Syntax
public Quantity SphereCenterX { get; }

SphereCenterY
Gets the SphereCenterY.

Declaration Syntax
public Quantity SphereCenterY { get; }

SphereCenterZ
Gets the SphereCenterZ.

Declaration Syntax
public Quantity SphereCenterZ { get; }

SphereRadius
Gets or sets the SphereRadius.

Declaration Syntax
public Quantity SphereRadius { set;get; }

Type
Gets or sets the Type.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

167

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Declaration Syntax
public SizingType Type { set;get; }

168

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.DesignModeler
Table 135: Members
Extrusion

Defines a Extrusion.

Feature

Defines a Feature.

FeatureManager Defines a
FeatureManager.
NamedSelection Defines a
NamedSelection.

Extrusion
Defines a Extrusion.

Declaration Syntax
public class Extrusion : Feature
Table 136: Members
Property Depth

Gets or sets the Depth.

Property Depth2 Gets or sets the Depth2.


Property Id

Gets the id of the


feature.
(Inherited from Feature.)

Property Name

Gets the name of the


feature.
(Inherited from Feature.)

Property Thin1

Gets or sets the Thin1.

Property Thin2

Gets or sets the Thin2.

Property Walled

Gets or sets the Walled.

Depth
Gets or sets the Depth.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

169

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 137: Members
Property Id

Gets the id of the


feature.

Property Name Gets the name of the


feature.

170

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

FeatureManager

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 138: Members
Property Count

Gets the number of features.

Property Item

Gets a feature by its index.

Method CreateNamedSelection() Creates a new NamedSelection


feature.
Method Generate()

Generates non-generated features


if any.

Count
Gets the number of features.

Declaration Syntax
public int Count { get; }

Item
Gets a feature by its index.

Declaration Syntax
public Feature Item { get; }

CreateNamedSelection()
Creates a new NamedSelection feature.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

171

Ansys.ACT.Automation.DesignModeler Namespace

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 139: Members
Property ExportNamedSelection

Gets or sets the


ExportNamedSelection.

Property Id

Gets the id of the feature.


(Inherited from Feature.)

Property IncludeInLegend

Gets or sets the IncludeInLegend.

Property Name

Gets the name of the feature.


(Inherited from Feature.)

Property NumGeometry

Gets the NumGeometry.

Property PropagateNamedSelection Gets or sets the


PropagateNamedSelection.

ExportNamedSelection
Gets or sets the ExportNamedSelection.

Declaration Syntax
public YesNo ExportNamedSelection { set;get; }

IncludeInLegend
Gets or sets the IncludeInLegend.

Declaration Syntax
public YesNo IncludeInLegend { set;get; }

172

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

NamedSelection

NumGeometry
Gets the NumGeometry.

Declaration Syntax
public int NumGeometry { get; }

PropagateNamedSelection
Gets or sets the PropagateNamedSelection.

Declaration Syntax
public YesNo PropagateNamedSelection { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

173

174

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.Mechanical.Connections Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Connections
Table 140: Members
BeamConnection

Defines a
BeamConnection.

Bearing

Defines a Bearing.

ConnectionGroup Defines a
ConnectionGroup.
ContactGroup

Defines a
ContactGroup.

ContactRegion

Defines a
ContactRegion.

Joint

Defines a Joint.

Spring

Defines a Spring.

BeamConnection
Defines a BeamConnection.

Declaration Syntax
public class BeamConnection : DataModelObject
Table 141: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property CrossSectionType

Gets the CrossSectionType.

Property Figures

Gets the list of associated figures.

Property Hidden

Gets the Hidden.

Property MaterialName

Gets or sets the MaterialName.

Property MobileAppliedBy

Gets or sets the MobileAppliedBy.

Property MobileBehavior

Gets or sets the MobileBehavior.

Property MobileBodyName

Gets the MobileBodyName.

Property MobileCoordinateSystemSelection

Gets or sets the


MobileCoordinateSystemSelection.

Property MobileLocation

Gets or sets the MobileLocation.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

175

Ansys.ACT.Automation.Mechanical.Connections Namespace
Property MobileLocationX

Gets or sets the MobileLocationX.

Property MobileLocationY

Gets or sets the MobileLocationY.

Property MobileLocationZ

Gets or sets the MobileLocationZ.

Property MobilePinballSize

Gets or sets the MobilePinballSize.

Property Prototypes

Gets the Prototypes.

Property Radius

Gets or sets the Radius.

Property ReferenceAppliedBy

Gets or sets the ReferenceAppliedBy.

Property ReferenceBehavior

Gets or sets the ReferenceBehavior.

Property ReferenceBodyName

Gets the ReferenceBodyName.

Property ReferenceCoordinateSystemSelection Gets or sets the


ReferenceCoordinateSystemSelection.
Property ReferenceLocation

Gets or sets the ReferenceLocation.

Property ReferenceLocationPoint

Gets or sets the ReferenceLocationPoint.

Property ReferenceLocationX

Gets or sets the ReferenceLocationX.

Property ReferenceLocationY

Gets or sets the ReferenceLocationY.

Property ReferenceLocationZ

Gets or sets the ReferenceLocationZ.

Property ReferencePinballSize

Gets or sets the ReferencePinballSize.

Property ScopingType

Gets or sets the ScopingType.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CrossSectionType
Gets the CrossSectionType.

Declaration Syntax
public CrossSectionType CrossSectionType { get; }

176

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

BeamConnection

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Hidden
Gets the Hidden.

Declaration Syntax
public bool Hidden { get; }

MaterialName
Gets or sets the MaterialName.

Declaration Syntax
public string MaterialName { set;get; }

MobileAppliedBy
Gets or sets the MobileAppliedBy.

Declaration Syntax
public RemoteApplicationType MobileAppliedBy { set;get; }

MobileBehavior
Gets or sets the MobileBehavior.

Declaration Syntax
public LoadBehaviorType MobileBehavior { set;get; }

MobileBodyName
Gets the MobileBodyName.

Declaration Syntax
public string MobileBodyName { get; }

MobileCoordinateSystemSelection
Gets or sets the MobileCoordinateSystemSelection.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

177

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public ICoordinateSystem MobileCoordinateSystemSelection { set;get; }

MobileLocation
Gets or sets the MobileLocation.

Declaration Syntax
public ISelectionInfo MobileLocation { set;get; }

MobileLocationX
Gets or sets the MobileLocationX.

Declaration Syntax
public Quantity MobileLocationX { set;get; }

MobileLocationY
Gets or sets the MobileLocationY.

Declaration Syntax
public Quantity MobileLocationY { set;get; }

MobileLocationZ
Gets or sets the MobileLocationZ.

Declaration Syntax
public Quantity MobileLocationZ { set;get; }

MobilePinballSize
Gets or sets the MobilePinballSize.

Declaration Syntax
public Quantity MobilePinballSize { set;get; }

Prototypes
Gets the Prototypes.

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

178

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

BeamConnection

Radius
Gets or sets the Radius.

Declaration Syntax
public Quantity Radius { set;get; }

ReferenceAppliedBy
Gets or sets the ReferenceAppliedBy.

Declaration Syntax
public RemoteApplicationType ReferenceAppliedBy { set;get; }

ReferenceBehavior
Gets or sets the ReferenceBehavior.

Declaration Syntax
public LoadBehaviorType ReferenceBehavior { set;get; }

ReferenceBodyName
Gets the ReferenceBodyName.

Declaration Syntax
public string ReferenceBodyName { get; }

ReferenceCoordinateSystemSelection
Gets or sets the ReferenceCoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem ReferenceCoordinateSystemSelection { set;get; }

ReferenceLocation
Gets or sets the ReferenceLocation.

Declaration Syntax
public ISelectionInfo ReferenceLocation { set;get; }

ReferenceLocationPoint
Gets or sets the ReferenceLocationPoint.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

179

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public ISelectionInfo ReferenceLocationPoint { set;get; }

ReferenceLocationX
Gets or sets the ReferenceLocationX.

Declaration Syntax
public Quantity ReferenceLocationX { set;get; }

ReferenceLocationY
Gets or sets the ReferenceLocationY.

Declaration Syntax
public Quantity ReferenceLocationY { set;get; }

ReferenceLocationZ
Gets or sets the ReferenceLocationZ.

Declaration Syntax
public Quantity ReferenceLocationZ { set;get; }

ReferencePinballSize
Gets or sets the ReferencePinballSize.

Declaration Syntax
public Quantity ReferencePinballSize { set;get; }

ScopingType
Gets or sets the ScopingType.

Declaration Syntax
public SpringScopingType ScopingType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

180

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Bearing

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Bearing
Defines a Bearing.

Declaration Syntax
public class Bearing : DataModelObject
Table 142: Members
Property AnsBCType

Gets the AnsBCType.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property DampingC11

Gets the DampingC11.

Property DampingC12

Gets the DampingC12.

Property DampingC21

Gets the DampingC21.

Property DampingC22

Gets the DampingC22.

Property Figures

Gets the list of associated figures.

Property MobileBehavior

Gets or sets the MobileBehavior.

Property MobileBodyName

Gets the MobileBodyName.

Property MobileCoordinateSystem

Gets or sets the


MobileCoordinateSystem.

Property MobileLocation

Gets or sets the MobileLocation.

Property MobileLocationX

Gets the MobileLocationX.

Property MobileLocationY

Gets the MobileLocationY.

Property MobileLocationZ

Gets the MobileLocationZ.

Property MobilePinballSize

Gets or sets the MobilePinballSize.

Property Prototypes

Gets the Prototypes.

Property ReferenceBehavior

Gets or sets the ReferenceBehavior.

Property ReferenceBodyName

Gets the ReferenceBodyName.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

181

Ansys.ACT.Automation.Mechanical.Connections Namespace
Property ReferenceCoordinateSystem Gets or sets the
ReferenceCoordinateSystem.
Property ReferencePinballSize

Gets or sets the ReferencePinballSize.

Property ReferenceRotationPlane

Gets or sets the


ReferenceRotationPlane.

Property ReferenceSet

Gets or sets the ReferenceSet.

Property ScopingType

Gets the ScopingType.

Property StiffnessK11

Gets the StiffnessK11.

Property StiffnessK12

Gets the StiffnessK12.

Property StiffnessK21

Gets the StiffnessK21.

Property StiffnessK22

Gets the StiffnessK22.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

AnsBCType
Gets the AnsBCType.

Declaration Syntax
public int AnsBCType { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DampingC11
Gets the DampingC11.

Declaration Syntax
public Field DampingC11 { get; }

182

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Bearing

DampingC12
Gets the DampingC12.

Declaration Syntax
public Field DampingC12 { get; }

DampingC21
Gets the DampingC21.

Declaration Syntax
public Field DampingC21 { get; }

DampingC22
Gets the DampingC22.

Declaration Syntax
public Field DampingC22 { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

MobileBehavior
Gets or sets the MobileBehavior.

Declaration Syntax
public LoadBehaviorType MobileBehavior { set;get; }

MobileBodyName
Gets the MobileBodyName.

Declaration Syntax
public string MobileBodyName { get; }

MobileCoordinateSystem
Gets or sets the MobileCoordinateSystem.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

183

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public ICoordinateSystem MobileCoordinateSystem { set;get; }

MobileLocation
Gets or sets the MobileLocation.

Declaration Syntax
public ISelectionInfo MobileLocation { set;get; }

MobileLocationX
Gets the MobileLocationX.

Declaration Syntax
public Quantity MobileLocationX { get; }

MobileLocationY
Gets the MobileLocationY.

Declaration Syntax
public Quantity MobileLocationY { get; }

MobileLocationZ
Gets the MobileLocationZ.

Declaration Syntax
public Quantity MobileLocationZ { get; }

MobilePinballSize
Gets or sets the MobilePinballSize.

Declaration Syntax
public Quantity MobilePinballSize { set;get; }

Prototypes
Gets the Prototypes.

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

184

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Bearing

ReferenceBehavior
Gets or sets the ReferenceBehavior.

Declaration Syntax
public LoadBehaviorType ReferenceBehavior { set;get; }

ReferenceBodyName
Gets the ReferenceBodyName.

Declaration Syntax
public string ReferenceBodyName { get; }

ReferenceCoordinateSystem
Gets or sets the ReferenceCoordinateSystem.

Declaration Syntax
public ICoordinateSystem ReferenceCoordinateSystem { set;get; }

ReferencePinballSize
Gets or sets the ReferencePinballSize.

Declaration Syntax
public Quantity ReferencePinballSize { set;get; }

ReferenceRotationPlane
Gets or sets the ReferenceRotationPlane.

Declaration Syntax
public RotationPlane ReferenceRotationPlane { set;get; }

ReferenceSet
Gets or sets the ReferenceSet.

Declaration Syntax
public ISelectionInfo ReferenceSet { set;get; }

ScopingType
Gets the ScopingType.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

185

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public ConnectionScopingType ScopingType { get; }

StiffnessK11
Gets the StiffnessK11.

Declaration Syntax
public Field StiffnessK11 { get; }

StiffnessK12
Gets the StiffnessK12.

Declaration Syntax
public Field StiffnessK12 { get; }

StiffnessK21
Gets the StiffnessK21.

Declaration Syntax
public Field StiffnessK21 { get; }

StiffnessK22
Gets the StiffnessK22.

Declaration Syntax
public Field StiffnessK22 { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

186

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ConnectionGroup

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

ConnectionGroup
Defines a ConnectionGroup.

Declaration Syntax
public class ConnectionGroup : DataModelObject
Table 143: Members
Property BeamConnections

Gets the BeamConnections.

Property Bearings

Gets the Bearings.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property ContactRegions

Gets the ContactRegions.

Property DetectionMode

Gets or sets the DetectionMode.

Property Figures

Gets the list of associated


figures.

Property FixedJoints

Gets or sets the FixedJoints.

Property Joints

Gets the Joints.

Property MeshConnections

Gets the MeshConnections.

Property Springs

Gets the Springs.

Property TransparencyEnabled

Gets or sets the


TransparencyEnabled.

Method AddBeamConnection() Creates a new child


BeamConnection.
Method AddBearing()

Creates a new child Bearing.

Method AddComment()

Creates a new child Comment.

Method AddContactGroup()

Creates a new child


ContactGroup.

Method AddFigure()

Creates a new child Figure.

Method AddSpring()

Creates a new child Spring.

BeamConnections
Gets the BeamConnections.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

187

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public IEnumerable<BeamConnection> BeamConnections { get; }

Bearings
Gets the Bearings.

Declaration Syntax
public IEnumerable<Bearing> Bearings { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ContactRegions
Gets the ContactRegions.

Declaration Syntax
public IEnumerable<ContactRegion> ContactRegions { get; }

DetectionMode
Gets or sets the DetectionMode.

Declaration Syntax
public AutoOrManual DetectionMode { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

188

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ConnectionGroup

FixedJoints
Gets or sets the FixedJoints.

Declaration Syntax
public bool FixedJoints { set;get; }

Joints
Gets the Joints.

Declaration Syntax
public IEnumerable<Joint> Joints { get; }

MeshConnections
Gets the MeshConnections.

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

Springs
Gets the Springs.

Declaration Syntax
public IEnumerable<Spring> Springs { get; }

TransparencyEnabled
Gets or sets the TransparencyEnabled.

Declaration Syntax
public bool TransparencyEnabled { set;get; }

AddBeamConnection()
Creates a new child BeamConnection.

Declaration Syntax
public BeamConnection AddBeamConnection()

AddBearing()
Creates a new child Bearing.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

189

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public Bearing AddBearing()

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddContactGroup()
Creates a new child ContactGroup.

Declaration Syntax
public ContactGroup AddContactGroup()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

AddSpring()
Creates a new child Spring.

Declaration Syntax
public Spring AddSpring()

ContactGroup
Defines a ContactGroup.

Declaration Syntax
public class ContactGroup : DataModelObject
Table 144: Members
Property AutoFixedJoints

Gets or sets the


AutoFixedJoints.

Property AutoRevoluteJoints

Gets or sets the


AutoRevoluteJoints.

Property BeamConnections

Gets the BeamConnections.

Property Children

Gets the list of children.

190

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactGroup
Property Comments

Gets the list of associated


comments.

Property ContactRegions

Gets the ContactRegions.

Property FaceEdgePriority

Gets or sets the


FaceEdgePriority.

Property Figures

Gets the list of associated


figures.

Property GeometrySelection

Gets or sets the


GeometrySelection.

Property GroupingType

Gets or sets the GroupingType.

Property Joints

Gets the Joints.

Property MinDistanceSlider

Gets or sets the


MinDistanceSlider.

Property MinDistanceValue

Gets or sets the


MinDistanceValue.

Property SearchingType

Gets or sets the SearchingType.

Property Springs

Gets the Springs.

Property Suppressed

Gets or sets the Suppressed.

Property ThicknessScaleFactor Gets or sets the


ThicknessScaleFactor.
Property ToleranceSlider

Gets or sets the ToleranceSlider.

Property ToleranceType

Gets or sets the ToleranceType.

Property ToleranceValue

Gets or sets the ToleranceValue.

Property UseEdgeEdge

Gets the UseEdgeEdge.

Property UseFaceEdge

Gets or sets the UseFaceEdge.

Property UseFaceFace

Gets or sets the UseFaceFace.

Property UseRange

Gets or sets the UseRange.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

AutoFixedJoints
Gets or sets the AutoFixedJoints.

Declaration Syntax
public bool AutoFixedJoints { set;get; }

AutoRevoluteJoints
Gets or sets the AutoRevoluteJoints.

Declaration Syntax
public bool AutoRevoluteJoints { set;get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

191

Ansys.ACT.Automation.Mechanical.Connections Namespace

BeamConnections
Gets the BeamConnections.

Declaration Syntax
public IEnumerable<BeamConnection> BeamConnections { get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ContactRegions
Gets the ContactRegions.

Declaration Syntax
public IEnumerable<ContactRegion> ContactRegions { get; }

FaceEdgePriority
Gets or sets the FaceEdgePriority.

Declaration Syntax
public ContactFaceEdgePriority FaceEdgePriority { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GeometrySelection
Gets or sets the GeometrySelection.

192

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactGroup

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

GroupingType
Gets or sets the GroupingType.

Declaration Syntax
public ContactGroupingType GroupingType { set;get; }

Joints
Gets the Joints.

Declaration Syntax
public IEnumerable<Joint> Joints { get; }

MinDistanceSlider
Gets or sets the MinDistanceSlider.

Declaration Syntax
public int MinDistanceSlider { set;get; }

MinDistanceValue
Gets or sets the MinDistanceValue.

Declaration Syntax
public Quantity MinDistanceValue { set;get; }

SearchingType
Gets or sets the SearchingType.

Declaration Syntax
public ContactSearchingType SearchingType { set;get; }

Springs
Gets the Springs.

Declaration Syntax
public IEnumerable<Spring> Springs { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

193

Ansys.ACT.Automation.Mechanical.Connections Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ThicknessScaleFactor
Gets or sets the ThicknessScaleFactor.

Declaration Syntax
public double ThicknessScaleFactor { 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; }

ToleranceValue
Gets or sets the ToleranceValue.

Declaration Syntax
public Quantity ToleranceValue { set;get; }

UseEdgeEdge
Gets the UseEdgeEdge.

Declaration Syntax
public ContactEdgeEdgeOption UseEdgeEdge { get; }

UseFaceEdge
Gets or sets the UseFaceEdge.

194

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactRegion

Declaration Syntax
public ContactFaceEdgeOption UseFaceEdge { set;get; }

UseFaceFace
Gets or sets the UseFaceFace.

Declaration Syntax
public bool UseFaceFace { set;get; }

UseRange
Gets or sets the UseRange.

Declaration Syntax
public int UseRange { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

ContactRegion
Defines a ContactRegion.

Declaration Syntax
public class ContactRegion : DataModelObject
Table 145: Members
Property AutoDetectionValue

Gets the AutoDetectionValue.

Property BeamMaterialName

Gets or sets the BeamMaterialName.

Property BeamRadius

Gets or sets the BeamRadius.

Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

195

Ansys.ACT.Automation.Mechanical.Connections Namespace
Property ContactCenterPoint

Gets or sets the ContactCenterPoint.

Property ContactCorrection

Gets or sets the ContactCorrection.

Property ContactEndingPoint

Gets the ContactEndingPoint.

Property ContactFormulation

Gets or sets the ContactFormulation.

Property ContactOrientation

Gets or sets the ContactOrientation.

Property ContactStartingPoint

Gets or sets the ContactStartingPoint.

Property ContactType

Gets or sets the ContactType.

Property DampingFactor

Gets or sets the DampingFactor.

Property DetectionMethod

Gets or sets the DetectionMethod.

Property ElasticSlipTolerance

Gets or sets the ElasticSlipTolerance.

Property ElasticSlipToleranceFactor

Gets or sets the


ElasticSlipToleranceFactor.

Property Figures

Gets the list of associated figures.

Property InterfaceTreatment

Gets or sets the InterfaceTreatment.

Property Mode

Gets the Mode.

Property NormalStiffness

Gets or sets the NormalStiffness.

Property PenetrationTolerance

Gets or sets the PenetrationTolerance.

Property PenetrationToleranceFactor

Gets or sets the


PenetrationToleranceFactor.

Property PinballFactor

Gets or sets the PinballFactor.

Property PinballRadius

Gets or sets the PinballRadius.

Property PinballType

Gets or sets the PinballType.

Property SourceComponentSelection

Gets the SourceComponentSelection.

Property SourceGeometry

Gets or sets the SourceGeometry.

Property SourceName

Gets the SourceName.

Property Suppressed

Gets or sets the Suppressed.

Property SymmetricContact

Gets or sets the SymmetricContact.

Property TargetCenterPoint

Gets the TargetCenterPoint.

Property TargetComponentSelection

Gets the TargetComponentSelection.

Property TargetCorrection

Gets or sets the TargetCorrection.

Property TargetEndingPoint

Gets the TargetEndingPoint.

Property TargetGeometry

Gets or sets the TargetGeometry.

Property TargetName

Gets the TargetName.

Property TargetOrientation

Gets or sets the TargetOrientation.

Property TargetStartingPoint

Gets the TargetStartingPoint.

Property TrimContact

Gets or sets the TrimContact.

Property TrimTolerance

Gets or sets the TrimTolerance.

Property UpdateContactStiffness

Gets or sets the UpdateContactStiffness.

Property UseAutoElasticSlipTolerance

Gets or sets the


UseAutoElasticSlipTolerance.

196

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactRegion
Property UseAutoNormalStiffness

Gets or sets the UseAutoNormalStiffness.

Property UseAutoPenetrationTolerance

Gets or sets the


UseAutoPenetrationTolerance.

Property UserOffset

Gets or sets the UserOffset.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

AutoDetectionValue
Gets the AutoDetectionValue.

Declaration Syntax
public Quantity AutoDetectionValue { get; }

BeamMaterialName
Gets or sets the BeamMaterialName.

Declaration Syntax
public string BeamMaterialName { set;get; }

BeamRadius
Gets or sets the BeamRadius.

Declaration Syntax
public Quantity BeamRadius { set;get; }

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ContactCenterPoint
Gets or sets the ContactCenterPoint.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

197

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public ICoordinateSystem ContactCenterPoint { set;get; }

ContactCorrection
Gets or sets the ContactCorrection.

Declaration Syntax
public ContactCorrection ContactCorrection { set;get; }

ContactEndingPoint
Gets the ContactEndingPoint.

Declaration Syntax
public ICoordinateSystem ContactEndingPoint { get; }

ContactFormulation
Gets or sets the ContactFormulation.

Declaration Syntax
public ContactFormulationType ContactFormulation { set;get; }

ContactOrientation
Gets or sets the ContactOrientation.

Declaration Syntax
public ContactOrientation ContactOrientation { set;get; }

ContactStartingPoint
Gets or sets the ContactStartingPoint.

Declaration Syntax
public ICoordinateSystem ContactStartingPoint { set;get; }

ContactType
Gets or sets the ContactType.

Declaration Syntax
public ContactType ContactType { set;get; }

198

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactRegion

DampingFactor
Gets or sets the DampingFactor.

Declaration Syntax
public double DampingFactor { set;get; }

DetectionMethod
Gets or sets the DetectionMethod.

Declaration Syntax
public ContactDetectionPoint DetectionMethod { set;get; }

ElasticSlipTolerance
Gets or sets the ElasticSlipTolerance.

Declaration Syntax
public Quantity ElasticSlipTolerance { set;get; }

ElasticSlipToleranceFactor
Gets or sets the ElasticSlipToleranceFactor.

Declaration Syntax
public double ElasticSlipToleranceFactor { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

InterfaceTreatment
Gets or sets the InterfaceTreatment.

Declaration Syntax
public ContactInitialEffect InterfaceTreatment { set;get; }

Mode
Gets the Mode.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

199

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public AutoOrManual Mode { get; }

NormalStiffness
Gets or sets the NormalStiffness.

Declaration Syntax
public double NormalStiffness { set;get; }

PenetrationTolerance
Gets or sets the PenetrationTolerance.

Declaration Syntax
public Quantity PenetrationTolerance { set;get; }

PenetrationToleranceFactor
Gets or sets the PenetrationToleranceFactor.

Declaration Syntax
public double PenetrationToleranceFactor { set;get; }

PinballFactor
Gets or sets the PinballFactor.

Declaration Syntax
public double PinballFactor { set;get; }

PinballRadius
Gets or sets the PinballRadius.

Declaration Syntax
public Quantity PinballRadius { set;get; }

PinballType
Gets or sets the PinballType.

Declaration Syntax
public ContactPinballType PinballType { set;get; }

200

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactRegion

SourceComponentSelection
Gets the SourceComponentSelection.

Declaration Syntax
public int SourceComponentSelection { get; }

SourceGeometry
Gets or sets the SourceGeometry.

Declaration Syntax
public ISelectionInfo SourceGeometry { set;get; }

SourceName
Gets the SourceName.

Declaration Syntax
public string SourceName { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

SymmetricContact
Gets or sets the SymmetricContact.

Declaration Syntax
public ContactBehavior SymmetricContact { set;get; }

TargetCenterPoint
Gets the TargetCenterPoint.

Declaration Syntax
public ICoordinateSystem TargetCenterPoint { get; }

TargetComponentSelection
Gets the TargetComponentSelection.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

201

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public int TargetComponentSelection { get; }

TargetCorrection
Gets or sets the TargetCorrection.

Declaration Syntax
public TargetCorrection TargetCorrection { set;get; }

TargetEndingPoint
Gets the TargetEndingPoint.

Declaration Syntax
public ICoordinateSystem TargetEndingPoint { get; }

TargetGeometry
Gets or sets the TargetGeometry.

Declaration Syntax
public ISelectionInfo TargetGeometry { set;get; }

TargetName
Gets the TargetName.

Declaration Syntax
public string TargetName { get; }

TargetOrientation
Gets or sets the TargetOrientation.

Declaration Syntax
public TargetOrientation TargetOrientation { set;get; }

TargetStartingPoint
Gets the TargetStartingPoint.

Declaration Syntax
public ICoordinateSystem TargetStartingPoint { get; }

202

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ContactRegion

TrimContact
Gets or sets the TrimContact.

Declaration Syntax
public ContactTrimType TrimContact { set;get; }

TrimTolerance
Gets or sets the TrimTolerance.

Declaration Syntax
public Quantity TrimTolerance { set;get; }

UpdateContactStiffness
Gets or sets the UpdateContactStiffness.

Declaration Syntax
public UpdateContactStiffness UpdateContactStiffness { set;get; }

UseAutoElasticSlipTolerance
Gets or sets the UseAutoElasticSlipTolerance.

Declaration Syntax
public ContactElasticSlipToleranceType UseAutoElasticSlipTolerance { set;get; }

UseAutoNormalStiffness
Gets or sets the UseAutoNormalStiffness.

Declaration Syntax
public bool UseAutoNormalStiffness { set;get; }

UseAutoPenetrationTolerance
Gets or sets the UseAutoPenetrationTolerance.

Declaration Syntax
public ContactPenetrationToleranceType UseAutoPenetrationTolerance { set;get; }

UserOffset
Gets or sets the UserOffset.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

203

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public Quantity UserOffset { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Joint
Defines a Joint.

Declaration Syntax
public class Joint : DataModelObject
Table 146: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property Figures

Gets the list of associated figures.

Property InitialPosition

Gets or sets the InitialPosition.

Property JointBehaviorMobile

Gets or sets the JointBehaviorMobile.

Property JointBehaviorReference

Gets or sets the JointBehaviorReference.

Property JointPinballSizeMobile

Gets or sets the JointPinballSizeMobile.

Property JointPinballSizeReference

Gets or sets the JointPinballSizeReference.

Property JointScopingType

Gets or sets the JointScopingType.

Property JointStopsRXMax

Gets or sets the JointStopsRXMax.

Property JointStopsRXMaxType

Gets or sets the JointStopsRXMaxType.

Property JointStopsRXMin

Gets or sets the JointStopsRXMin.

Property JointStopsRXMinType

Gets or sets the JointStopsRXMinType.

Property JointStopsRYMax

Gets or sets the JointStopsRYMax.

Property JointStopsRYMaxType

Gets or sets the JointStopsRYMaxType.

Property JointStopsRYMin

Gets or sets the JointStopsRYMin.

Property JointStopsRYMinType

Gets or sets the JointStopsRYMinType.

204

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Joint
Property JointStopsRZMax

Gets or sets the JointStopsRZMax.

Property JointStopsRZMaxType

Gets or sets the JointStopsRZMaxType.

Property JointStopsRZMin

Gets or sets the JointStopsRZMin.

Property JointStopsRZMinType

Gets or sets the JointStopsRZMinType.

Property JointStopsXMax

Gets or sets the JointStopsXMax.

Property JointStopsXMaxType

Gets or sets the JointStopsXMaxType.

Property JointStopsXMin

Gets or sets the JointStopsXMin.

Property JointStopsXMinType

Gets or sets the JointStopsXMinType.

Property JointStopsYMax

Gets or sets the JointStopsYMax.

Property JointStopsYMaxType

Gets or sets the JointStopsYMaxType.

Property JointStopsYMin

Gets or sets the JointStopsYMin.

Property JointStopsYMinType

Gets or sets the JointStopsYMinType.

Property JointStopsZMax

Gets or sets the JointStopsZMax.

Property JointStopsZMaxType

Gets or sets the JointStopsZMaxType.

Property JointStopsZMin

Gets or sets the JointStopsZMin.

Property JointStopsZMinType

Gets or sets the JointStopsZMinType.

Property JointType

Gets or sets the JointType.

Property MobileAppliedBy

Gets or sets the MobileAppliedBy.

Property MobileBodyName

Gets the MobileBodyName.

Property MobileCoordinateSystemSelection

Gets or sets the


MobileCoordinateSystemSelection.

Property MobileLocation

Gets or sets the MobileLocation.

Property Prototypes

Gets the Prototypes.

Property ReferenceAppliedBy

Gets or sets the ReferenceAppliedBy.

Property ReferenceBodyName

Gets the ReferenceBodyName.

Property ReferenceCoordinateSystemSelection Gets or sets the


ReferenceCoordinateSystemSelection.
Property ReferenceSet

Gets or sets the ReferenceSet.

Property SolverElementType

Gets or sets the SolverElementType.

Property Suppressed

Gets or sets the Suppressed.

Property SuppressedForSolve

Gets the SuppressedForSolve.

Property TortionalDamping

Gets or sets the TortionalDamping.

Property TortionalStiffness

Gets or sets the TortionalStiffness.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

205

Ansys.ACT.Automation.Mechanical.Connections Namespace

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

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

InitialPosition
Gets or sets the InitialPosition.

Declaration Syntax
public JointInitialPosition InitialPosition { set;get; }

JointBehaviorMobile
Gets or sets the JointBehaviorMobile.

Declaration Syntax
public LoadBehaviorType JointBehaviorMobile { set;get; }

JointBehaviorReference
Gets or sets the JointBehaviorReference.

Declaration Syntax
public LoadBehaviorType JointBehaviorReference { set;get; }

JointPinballSizeMobile
Gets or sets the JointPinballSizeMobile.

Declaration Syntax
public Quantity JointPinballSizeMobile { set;get; }

206

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Joint

JointPinballSizeReference
Gets or sets the JointPinballSizeReference.

Declaration Syntax
public Quantity JointPinballSizeReference { set;get; }

JointScopingType
Gets or sets the JointScopingType.

Declaration Syntax
public JointScopingType JointScopingType { set;get; }

JointStopsRXMax
Gets or sets the JointStopsRXMax.

Declaration Syntax
public double JointStopsRXMax { set;get; }

JointStopsRXMaxType
Gets or sets the JointStopsRXMaxType.

Declaration Syntax
public JointStopType JointStopsRXMaxType { set;get; }

JointStopsRXMin
Gets or sets the JointStopsRXMin.

Declaration Syntax
public double JointStopsRXMin { set;get; }

JointStopsRXMinType
Gets or sets the JointStopsRXMinType.

Declaration Syntax
public JointStopType JointStopsRXMinType { set;get; }

JointStopsRYMax
Gets or sets the JointStopsRYMax.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

207

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public double JointStopsRYMax { set;get; }

JointStopsRYMaxType
Gets or sets the JointStopsRYMaxType.

Declaration Syntax
public JointStopType JointStopsRYMaxType { set;get; }

JointStopsRYMin
Gets or sets the JointStopsRYMin.

Declaration Syntax
public double JointStopsRYMin { set;get; }

JointStopsRYMinType
Gets or sets the JointStopsRYMinType.

Declaration Syntax
public JointStopType JointStopsRYMinType { set;get; }

JointStopsRZMax
Gets or sets the JointStopsRZMax.

Declaration Syntax
public double JointStopsRZMax { set;get; }

JointStopsRZMaxType
Gets or sets the JointStopsRZMaxType.

Declaration Syntax
public JointStopType JointStopsRZMaxType { set;get; }

JointStopsRZMin
Gets or sets the JointStopsRZMin.

Declaration Syntax
public double JointStopsRZMin { set;get; }

208

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Joint

JointStopsRZMinType
Gets or sets the JointStopsRZMinType.

Declaration Syntax
public JointStopType JointStopsRZMinType { set;get; }

JointStopsXMax
Gets or sets the JointStopsXMax.

Declaration Syntax
public double JointStopsXMax { set;get; }

JointStopsXMaxType
Gets or sets the JointStopsXMaxType.

Declaration Syntax
public JointStopType JointStopsXMaxType { set;get; }

JointStopsXMin
Gets or sets the JointStopsXMin.

Declaration Syntax
public double JointStopsXMin { set;get; }

JointStopsXMinType
Gets or sets the JointStopsXMinType.

Declaration Syntax
public JointStopType JointStopsXMinType { set;get; }

JointStopsYMax
Gets or sets the JointStopsYMax.

Declaration Syntax
public double JointStopsYMax { set;get; }

JointStopsYMaxType
Gets or sets the JointStopsYMaxType.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

209

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public JointStopType JointStopsYMaxType { set;get; }

JointStopsYMin
Gets or sets the JointStopsYMin.

Declaration Syntax
public double JointStopsYMin { set;get; }

JointStopsYMinType
Gets or sets the JointStopsYMinType.

Declaration Syntax
public JointStopType JointStopsYMinType { set;get; }

JointStopsZMax
Gets or sets the JointStopsZMax.

Declaration Syntax
public double JointStopsZMax { set;get; }

JointStopsZMaxType
Gets or sets the JointStopsZMaxType.

Declaration Syntax
public JointStopType JointStopsZMaxType { set;get; }

JointStopsZMin
Gets or sets the JointStopsZMin.

Declaration Syntax
public double JointStopsZMin { set;get; }

JointStopsZMinType
Gets or sets the JointStopsZMinType.

Declaration Syntax
public JointStopType JointStopsZMinType { set;get; }

210

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Joint

JointType
Gets or sets the JointType.

Declaration Syntax
public JointType JointType { set;get; }

MobileAppliedBy
Gets or sets the MobileAppliedBy.

Declaration Syntax
public RemoteApplicationType MobileAppliedBy { set;get; }

MobileBodyName
Gets the MobileBodyName.

Declaration Syntax
public string MobileBodyName { get; }

MobileCoordinateSystemSelection
Gets or sets the MobileCoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem MobileCoordinateSystemSelection { set;get; }

MobileLocation
Gets or sets the MobileLocation.

Declaration Syntax
public ISelectionInfo MobileLocation { set;get; }

Prototypes
Gets the Prototypes.

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

ReferenceAppliedBy
Gets or sets the ReferenceAppliedBy.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

211

Ansys.ACT.Automation.Mechanical.Connections Namespace

Declaration Syntax
public RemoteApplicationType ReferenceAppliedBy { set;get; }

ReferenceBodyName
Gets the ReferenceBodyName.

Declaration Syntax
public string ReferenceBodyName { get; }

ReferenceCoordinateSystemSelection
Gets or sets the ReferenceCoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem ReferenceCoordinateSystemSelection { set;get; }

ReferenceSet
Gets or sets the ReferenceSet.

Declaration Syntax
public ISelectionInfo ReferenceSet { set;get; }

SolverElementType
Gets or sets the SolverElementType.

Declaration Syntax
public JointSolverElementType SolverElementType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

SuppressedForSolve
Gets the SuppressedForSolve.

Declaration Syntax
public bool SuppressedForSolve { get; }

212

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Spring

TortionalDamping
Gets or sets the TortionalDamping.

Declaration Syntax
public Quantity TortionalDamping { set;get; }

TortionalStiffness
Gets or sets the TortionalStiffness.

Declaration Syntax
public Quantity TortionalStiffness { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

Spring
Defines a Spring.

Declaration Syntax
public class Spring : DataModelObject
Table 147: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated comments.

Property Figures

Gets the list of associated figures.

Property Hidden

Gets or sets the Hidden.

Property LongitudinalDamping

Gets or sets the LongitudinalDamping.

Property LongitudinalStiffness

Gets or sets the LongitudinalStiffness.

Property MobileAppliedBy

Gets or sets the MobileAppliedBy.

Property MobileBodyName

Gets the MobileBodyName.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

213

Ansys.ACT.Automation.Mechanical.Connections Namespace
Property MobileCoordinateSystemSelection

Gets or sets the


MobileCoordinateSystemSelection.

Property MobileLocation

Gets or sets the MobileLocation.

Property MobileLocationSelection

Gets or sets the MobileLocationSelection.

Property MobileLocationX

Gets or sets the MobileLocationX.

Property MobileLocationY

Gets or sets the MobileLocationY.

Property MobileLocationZ

Gets or sets the MobileLocationZ.

Property PreloadLength

Gets or sets the PreloadLength.

Property PreloadLoad

Gets or sets the PreloadLoad.

Property Prototypes

Gets the Prototypes.

Property ReferenceAppliedBy

Gets or sets the ReferenceAppliedBy.

Property ReferenceBodyName

Gets the ReferenceBodyName.

Property ReferenceCoordinateSystemSelection Gets or sets the


ReferenceCoordinateSystemSelection.
Property ReferenceLocation

Gets or sets the ReferenceLocation.

Property ReferenceLocationSelection

Gets or sets the ReferenceLocationSelection.

Property ReferenceLocationX

Gets or sets the ReferenceLocationX.

Property ReferenceLocationY

Gets or sets the ReferenceLocationY.

Property ReferenceLocationZ

Gets or sets the ReferenceLocationZ.

Property SpringBehavior

Gets or sets the SpringBehavior.

Property SpringLength

Gets the SpringLength.

Property SpringMobileBehavior

Gets or sets the SpringMobileBehavior.

Property SpringMobilePinballSize

Gets or sets the SpringMobilePinballSize.

Property SpringPreloadType

Gets or sets the SpringPreloadType.

Property SpringReferenceBehavior

Gets or sets the SpringReferenceBehavior.

Property SpringReferencePinballSize

Gets or sets the SpringReferencePinballSize.

Property SpringScopingType

Gets or sets the SpringScopingType.

Property SpringType

Gets or sets the SpringType.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Comments
Gets the list of associated comments.

214

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Spring

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Hidden
Gets or sets the Hidden.

Declaration Syntax
public bool Hidden { set;get; }

LongitudinalDamping
Gets or sets the LongitudinalDamping.

Declaration Syntax
public Quantity LongitudinalDamping { set;get; }

LongitudinalStiffness
Gets or sets the LongitudinalStiffness.

Declaration Syntax
public Quantity LongitudinalStiffness { set;get; }

MobileAppliedBy
Gets or sets the MobileAppliedBy.

Declaration Syntax
public RemoteApplicationType MobileAppliedBy { set;get; }

MobileBodyName
Gets the MobileBodyName.

Declaration Syntax
public string MobileBodyName { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

215

Ansys.ACT.Automation.Mechanical.Connections Namespace

MobileCoordinateSystemSelection
Gets or sets the MobileCoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem MobileCoordinateSystemSelection { set;get; }

MobileLocation
Gets or sets the MobileLocation.

Declaration Syntax
public ISelectionInfo MobileLocation { set;get; }

MobileLocationSelection
Gets or sets the MobileLocationSelection.

Declaration Syntax
public ISelectionInfo MobileLocationSelection { set;get; }

MobileLocationX
Gets or sets the MobileLocationX.

Declaration Syntax
public Quantity MobileLocationX { set;get; }

MobileLocationY
Gets or sets the MobileLocationY.

Declaration Syntax
public Quantity MobileLocationY { set;get; }

MobileLocationZ
Gets or sets the MobileLocationZ.

Declaration Syntax
public Quantity MobileLocationZ { set;get; }

PreloadLength
Gets or sets the PreloadLength.

216

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Spring

Declaration Syntax
public Quantity PreloadLength { set;get; }

PreloadLoad
Gets or sets the PreloadLoad.

Declaration Syntax
public Quantity PreloadLoad { set;get; }

Prototypes
Gets the Prototypes.

Declaration Syntax
public IEnumerable<Prototype> Prototypes { get; }

ReferenceAppliedBy
Gets or sets the ReferenceAppliedBy.

Declaration Syntax
public RemoteApplicationType ReferenceAppliedBy { set;get; }

ReferenceBodyName
Gets the ReferenceBodyName.

Declaration Syntax
public string ReferenceBodyName { get; }

ReferenceCoordinateSystemSelection
Gets or sets the ReferenceCoordinateSystemSelection.

Declaration Syntax
public ICoordinateSystem ReferenceCoordinateSystemSelection { set;get; }

ReferenceLocation
Gets or sets the ReferenceLocation.

Declaration Syntax
public ISelectionInfo ReferenceLocation { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

217

Ansys.ACT.Automation.Mechanical.Connections Namespace

ReferenceLocationSelection
Gets or sets the ReferenceLocationSelection.

Declaration Syntax
public ISelectionInfo ReferenceLocationSelection { set;get; }

ReferenceLocationX
Gets or sets the ReferenceLocationX.

Declaration Syntax
public Quantity ReferenceLocationX { set;get; }

ReferenceLocationY
Gets or sets the ReferenceLocationY.

Declaration Syntax
public Quantity ReferenceLocationY { set;get; }

ReferenceLocationZ
Gets or sets the ReferenceLocationZ.

Declaration Syntax
public Quantity ReferenceLocationZ { set;get; }

SpringBehavior
Gets or sets the SpringBehavior.

Declaration Syntax
public SpringBehavior SpringBehavior { set;get; }

SpringLength
Gets the SpringLength.

Declaration Syntax
public Quantity SpringLength { get; }

SpringMobileBehavior
Gets or sets the SpringMobileBehavior.

218

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Spring

Declaration Syntax
public LoadBehaviorType SpringMobileBehavior { set;get; }

SpringMobilePinballSize
Gets or sets the SpringMobilePinballSize.

Declaration Syntax
public Quantity SpringMobilePinballSize { set;get; }

SpringPreloadType
Gets or sets the SpringPreloadType.

Declaration Syntax
public SpringPreloadType SpringPreloadType { set;get; }

SpringReferenceBehavior
Gets or sets the SpringReferenceBehavior.

Declaration Syntax
public LoadBehaviorType SpringReferenceBehavior { set;get; }

SpringReferencePinballSize
Gets or sets the SpringReferencePinballSize.

Declaration Syntax
public Quantity SpringReferencePinballSize { set;get; }

SpringScopingType
Gets or sets the SpringScopingType.

Declaration Syntax
public SpringScopingType SpringScopingType { set;get; }

SpringType
Gets or sets the SpringType.

Declaration Syntax
public SpringType SpringType { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

219

Ansys.ACT.Automation.Mechanical.Connections Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

220

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.AAP.Common Namespace
Declaration Syntax
namespace Ansys.AAP.Common
Table 148: Members
CoordinateSystem CoordinateSystem
class

CoordinateSystem
CoordinateSystem class

Declaration Syntax
public class CoordinateSystem : ICoordinateSystem
Table 149: Members
Constructor CoordinateSystem(CoordinateSystemTypeEnum) Constructor.
Property

CoordinateSystemType

Gets or sets the coordinate system


type.

Property

Id

Gets or sets the ID of the coordinate


system.

Property

Matrix

Gets or sets the matrix definition of the


coordinate system.

Property

Name

Gets or sets the name of the


coordinate system.

Property

Origin

Gets or sets the origin of the


coordinate system.

Property

XAxis

Gets or sets the X axis of the


coordinate system.

Property

YAxis

Gets or sets the Y axis of the


coordinate system.

Property

ZAxis

Gets or sets the Z axis of the


coordinate system.

CoordinateSystem(CoordinateSystemTypeEnum)
Constructor.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

221

Ansys.AAP.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; }

XAxis
Gets or sets the X axis of the coordinate system.

222

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

CoordinateSystem

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 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

223

224

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Automation.Mechanical.Boundaries Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Boundaries
Table 150: Members
Boundary

Defines a
Boundary.

EarthGravity

Defines a
EarthGravity.

FixedSupport Defines a
FixedSupport.

Boundary
Defines a Boundary.

Declaration Syntax
public class Boundary : DataModelObject
Table 151: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property Figures

Gets the list of associated


figures.

Property Magnitude

Gets the Magnitude.

Property Suppressed

Gets or sets the Suppressed.

Method AddComment() Creates a new child Comment.


Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

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

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

225

Ansys.ACT.Automation.Mechanical.Boundaries Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Magnitude
Gets the Magnitude.

Declaration Syntax
public Field Magnitude { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

EarthGravity
Defines a EarthGravity.

226

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

EarthGravity

Declaration Syntax
public class EarthGravity : DataModelObject
Table 152: Members
Property Children

Gets the list of children.

Property Comments

Gets the list of associated


comments.

Property CoordinateSystem

Gets or sets the


CoordinateSystem.

Property Figures

Gets the list of associated


figures.

Property GravityOrientation Gets or sets the


GravityOrientation.
Property Suppressed

Gets or sets the Suppressed.

Method AddComment()

Creates a new child Comment.

Method AddFigure()

Creates a new child Figure.

Children
Gets the list of children.

Declaration Syntax
public IEnumerable<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 ICoordinateSystem CoordinateSystem { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

227

Ansys.ACT.Automation.Mechanical.Boundaries Namespace

GravityOrientation
Gets or sets the GravityOrientation.

Declaration Syntax
public GravityOrientationType GravityOrientation { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public Figure AddFigure()

FixedSupport
Defines a FixedSupport.

Declaration Syntax
public class FixedSupport : Boundary
Table 153: Members
Property Children

Gets the list of children.


(Inherited from Boundary.)

Property Comments

Gets the list of associated


comments.
(Inherited from Boundary.)

Property Figures

228

Gets the list of associated


figures.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

FixedSupport
(Inherited from Boundary.)
Property GeometrySelection Gets or sets the
GeometrySelection.
Property Magnitude

Gets the Magnitude.


(Inherited from Boundary.)

Property Suppressed

Gets or sets the Suppressed.


(Inherited from Boundary.)

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

229

230

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.UserObject Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.UserObject
Table 154: Members
IPropertyCollection

Defines a collection of properties.

ISimProperty

Exposes a property.

ISimPropertyGroup

Defines a property group.

ISimPropertyTable

Defines a property table.

IUserLoad

Defines a user load.

IUserObject

Defines a user object.

IUserResult

Defines a user result.

IUserSolver

Defines a user solver.

ObjectLocationEnum

Specifies the object locations.

ObjectTypeEnum

Specifies the object types.

PropertyDisplayEnum

Specifies the property's display types.

UpdateStateFreqEnum Specifies when the state have to be


evaluated.
ValidStateEnum

Specifies the state value.

IPropertyCollection
Defines a collection of properties.

Declaration Syntax
public interface IPropertyCollection
Table 155: Members
Property Count

Gets the number of properties in the collection.

Property Item

Gets the property that matches the given


name.

Method Contains(ISimProperty) Checks if the collection contains the property.


Method GetByName(string)

Returns the property that matches the given


name.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

231

Ansys.ACT.Interfaces.UserObject Namespace

Count
Gets the number of properties in the collection.

Declaration Syntax
public int Count { get; }

Item
Gets the property that matches the given name.

Declaration Syntax
public ISimProperty Item { get; }

Contains(ISimProperty)
Checks if the collection contains the property.

Declaration Syntax
public bool Contains(ISimProperty property)

Parameters
property(ISimProperty)
The property.

GetByName(string)
Returns the property that matches the given name.

Declaration Syntax
public ISimProperty GetByName(string name)

Parameters
name(string)
The name.

ISimProperty
Exposes a property.

Declaration Syntax
public interface ISimProperty
Table 156: Members
Property Attributes
232

Gets attributes associated to the property.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISimProperty
Property Caption

Gets or sets the caption of the property.

Property Control

Gets the control type of the property.

Property Controller

Gets the controller instance associated with the property.

Property DefaultValue

Gets the default value of the property.

Property Displayed

Gets a value indicating whether the property is displayed.

Property HasUnit

Gets a value indicating whether the property has a defined


unit.

Property Id

Gets the identifier of the property.

Property InternalValue

Gets or sets the internal value of the property.

Property IsGroup

Gets a value indicating whether the property is a group.

Property IsTable

Gets a value indicating whether the property is a table.

Property IsValid

Gets a value indicating whether the property is valid.

Property Name

Gets the name of the property.

Property Options

Gets or sets the property's string options for a 'select' control.

Property ParentCaption

Gets the parent caption of the property.

Property ParentPropertyGroup Gets the parent property group.


Property QuantityName

Gets the quantity name of the property.

Property ReadOnly

Gets or sets a value indicating whether the property is read


only.

Property UniqueName

Gets the unique name of the property.

Property UnitString

Gets the unit string of the property.

Property Value

Gets or sets the value of the property.

Property ValueString

Gets or sets the value string of the property.

Property Visible

Gets or sets a value indicating whether the property is visible.

Attributes
Gets attributes associated to the property.

Declaration Syntax
public IAttributeCollection Attributes { get; }

Caption
Gets or sets the caption of the property.

Declaration Syntax
public string Caption { set;get; }

Control
Gets the control type of the property.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

233

Ansys.ACT.Interfaces.UserObject Namespace

Declaration Syntax
public string Control { get; }

Controller
Gets the controller instance associated with the property.

Declaration Syntax
public object Controller { get; }

DefaultValue
Gets the default value of the property.

Declaration Syntax
public object DefaultValue { get; }

Displayed
Gets a value indicating whether the property is displayed.

Declaration Syntax
public bool Displayed { get; }

HasUnit
Gets a value indicating whether the property has a defined unit.

Declaration Syntax
public bool HasUnit { get; }

Id
Gets the identifier of the property.

Declaration Syntax
public int Id { get; }

InternalValue
Gets or sets the internal value of the property.

Declaration Syntax
public object InternalValue { set;get; }

234

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISimProperty

IsGroup
Gets a value indicating whether the property is a group.

Declaration Syntax
public bool IsGroup { get; }

IsTable
Gets a value indicating whether the property is a table.

Declaration Syntax
public bool IsTable { get; }

IsValid
Gets a value indicating whether the property is valid.

Declaration Syntax
public bool IsValid { get; }

Name
Gets the name of the property.

Declaration Syntax
public string Name { get; }

Options
Gets or sets the property's string options for a 'select' control.

Declaration Syntax
public List<string> Options { set;get; }

ParentCaption
Gets the parent caption of the property.

Declaration Syntax
public string ParentCaption { get; }

ParentPropertyGroup
Gets the parent property group.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

235

Ansys.ACT.Interfaces.UserObject Namespace

Declaration Syntax
public ISimPropertyGroup ParentPropertyGroup { get; }

QuantityName
Gets the quantity name of the property.

Declaration Syntax
public string QuantityName { get; }

ReadOnly
Gets or sets a value indicating whether the property is read only.

Declaration Syntax
public bool ReadOnly { set;get; }

UniqueName
Gets the unique name of the property.

Declaration Syntax
public string UniqueName { get; }

UnitString
Gets the unit string of the property.

Declaration Syntax
public string UnitString { get; }

Value
Gets or sets the value of the property.

Declaration Syntax
public object Value { set;get; }

ValueString
Gets or sets the value string of the property.

Declaration Syntax
public string ValueString { set;get; }

236

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISimPropertyTable

Visible
Gets or sets a value indicating whether the property is visible.

Declaration Syntax
public bool Visible { set;get; }

ISimPropertyGroup
Defines a property group.

Declaration Syntax
public interface ISimPropertyGroup
Table 157: Members
Property AllDescendants Gets all properties of this group and all
sub-groups.
Property Display

Gets the display type of the property.

Property Properties

Gets the collection of children properties.

AllDescendants
Gets all properties of this group and all sub-groups.

Declaration Syntax
public IEnumerable<ISimProperty> AllDescendants { get; }

Display
Gets the display type of the property.

Declaration Syntax
public PropertyDisplayEnum Display { get; }

Properties
Gets the collection of children properties.

Declaration Syntax
public IPropertyCollection Properties { get; }

ISimPropertyTable
Defines a property table.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

237

Ansys.ACT.Interfaces.UserObject Namespace

Declaration Syntax
public interface ISimPropertyTable
Table 158: Members
Property ActiveRow

Gets or sets the active row.

Property RowCount

Gets the row count.

Property UpdateStateFreq Gets or sets the frequency of update


state.
Property ValidState

Gets or sets the valid state.

Method AddRow()

Adds a new row.

Method DeleteRow(int)

Deletes a row by its index.

Method SaveActiveRow()

Saves the data associated with the active


row.

ActiveRow
Gets or sets the active row.

Declaration Syntax
public int ActiveRow { set;get; }

RowCount
Gets the row count.

Declaration Syntax
public int RowCount { get; }

UpdateStateFreq
Gets or sets the frequency of update state.

Declaration Syntax
public UpdateStateFreqEnum UpdateStateFreq { set;get; }

ValidState
Gets or sets the valid state.

Declaration Syntax
public ValidStateEnum ValidState { set;get; }

AddRow()
Adds a new row.
238

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserLoad

Declaration Syntax
public void AddRow()

DeleteRow(int)
Deletes a row by its index.

Declaration Syntax
public void DeleteRow(int index)

Parameters
index(int)
Index of the row (0 for first row).

SaveActiveRow()
Saves the data associated with the active row.

Declaration Syntax
public void SaveActiveRow()

IUserLoad
Defines a user load.

Declaration Syntax
public interface IUserLoad
Table 159: Members
Property Children

Gets the list of children objects.

Property Color

Gets or sets the color associated with this entity. This color is used by
default to display the scoped geometry.

Property IsLoad

Gets a boolean value that indicates if the object is a "load".

Property IsSupport

Gets a boolean value that indicates if the object is a "support".

Property Suppressed

Gets or sets the suppression state.

Method CreateChild(string) Creates a new child object.

Children
Gets the list of children objects.

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

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

239

Ansys.ACT.Interfaces.UserObject Namespace

Color
Gets or sets the color associated with this entity. This color is used by default to display the scoped
geometry.

Declaration Syntax
public int Color { set;get; }

IsLoad
Gets a boolean value that indicates if the object is a "load".

Declaration Syntax
public bool IsLoad { get; }

IsSupport
Gets a boolean value that indicates if the object is a "support".

Declaration Syntax
public bool IsSupport { get; }

Suppressed
Gets or sets the suppression state.

Declaration Syntax
public bool Suppressed { set;get; }

CreateChild(string)
Creates a new child object.

Declaration Syntax
public IUserLoad CreateChild(string name)

Parameters
name(string)
The name of the object to create.

IUserObject
Defines a user object.

240

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserObject

Declaration Syntax
public interface IUserObject
Table 160: Members
Property AllProperties Gets all properties (flat view).
Property Attributes

Gets the collection of attributes.

Property Caption

Gets the caption of the object.

Property Controller

Gets the controller associated to the


object.

Property Extension

Gets the extension associated to the


object.

Property Icon

Gets the icon name of the object.

Property Id

Gets the identifier of the object.

Property Name

Gets the internal name of the object.

Property Properties

Gets the collection of properties.

Property State

Gets the state of the object.

Property Version

Gets the version of the object.

AllProperties
Gets all properties (flat view).

Declaration Syntax
public IEnumerable<ISimProperty> AllProperties { get; }

Attributes
Gets the collection of attributes.

Declaration Syntax
public IAttributeCollection Attributes { get; }

Caption
Gets the caption of the object.

Declaration Syntax
public string Caption { get; }

Controller
Gets the controller associated to the object.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

241

Ansys.ACT.Interfaces.UserObject Namespace

Declaration Syntax
public object Controller { get; }

Extension
Gets the extension associated to the object.

Declaration Syntax
public IExtension Extension { get; }

Icon
Gets the icon name of the object.

Declaration Syntax
public string Icon { get; }

Id
Gets the identifier of the object.

Declaration Syntax
public int Id { get; }

Name
Gets the internal name of the object.

Declaration Syntax
public string Name { get; }

Properties
Gets the collection of properties.

Declaration Syntax
public IPropertyCollection Properties { get; }

State
Gets the state of the object.

Declaration Syntax
public string State { get; }

242

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserResult

Version
Gets the version of the object.

Declaration Syntax
public int Version { get; }

IUserResult
Defines a user result.

Declaration Syntax
public interface IUserResult
Table 161: Members
Property CalculateTimeHistory Gets or sets a boolean value that indicates if the time history has to
be evaluated (false by default).
Property HasImaginary

Gets or sets a boolean value that indicate if the result support


imaginary values.

Property ResultAveraging

Gets or sets the averaging mode.

Property ResultLocation

Gets or sets the location.

Property ResultType

Gets or sets the type.

Property Suppressed

Gets or sets the suppression state of the result.

Property Unit

Gets or sets the unit.

CalculateTimeHistory
Gets or sets a boolean value that indicates if the time history has to be evaluated (false by default).

Declaration Syntax
public bool CalculateTimeHistory { set;get; }

HasImaginary
Gets or sets a boolean value that indicate if the result support imaginary values.

Declaration Syntax
public bool HasImaginary { set;get; }

ResultAveraging
Gets or sets the averaging mode.

Declaration Syntax
public ResultAveragingEnum ResultAveraging { set;get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

243

Ansys.ACT.Interfaces.UserObject Namespace

ResultLocation
Gets or sets the location.

Declaration Syntax
public ResultLocationEnum ResultLocation { set;get; }

ResultType
Gets or sets the type.

Declaration Syntax
public ResultTypeEnum ResultType { set;get; }

Suppressed
Gets or sets the suppression state of the result.

Declaration Syntax
public bool Suppressed { set;get; }

Unit
Gets or sets the unit.

Declaration Syntax
public string Unit { set;get; }

IUserSolver
Defines a user solver.

Declaration Syntax
public interface IUserSolver
Table 162: Members
Property AnalysisType Gets the analysis
type.
Property PhysicsType

Gets the physics


type.

AnalysisType
Gets the analysis type.

244

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

PropertyDisplayEnum

Declaration Syntax
public string AnalysisType { get; }

PhysicsType
Gets the physics type.

Declaration Syntax
public string PhysicsType { get; }

ObjectLocationEnum
Specifies the object locations.

Declaration Syntax
public enum ObjectLocationEnum
Table 163: Members
Member Default

Indicates that the object location is the default location of its container
object.

Member Post

Indicates that the object location is the 'post' part of its container object.

Member Pre

Indicates that the object location is the 'pre' part of its container object.

Member Unknown Indicates that the object location is unknown.

ObjectTypeEnum
Specifies the object types.

Declaration Syntax
public enum ObjectTypeEnum
Table 164: Members
Member Analysis

Indicates that the object is the current analysis.

Member DataModel Indicates that the object is the current data


model.
Member Unknown Indicates that the object is not known.
Member UserObject Indicates that the object is a user object.

PropertyDisplayEnum
Specifies the property's display types.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

245

Ansys.ACT.Interfaces.UserObject Namespace

Declaration Syntax
public enum PropertyDisplayEnum
Table 165: Members
Member Caption

Indicates that the property is displayed as a caption.

Member Hidden

Indicates that the property is hidden.

Member None

Indicates that the property is ignored.

Member Property

Indicates that the property is displayed as standard


property.

Member Worksheet Indicates that the property is displayed as a worksheet.

UpdateStateFreqEnum
Specifies when the state have to be evaluated.

Declaration Syntax
public enum UpdateStateFreqEnum
Table 166: Members
Member UpdateEachTime The state will be computed each time a cell of the tabular data is
modified.
Member UpdateOnApply The state will be computed only when the tabular data is closed.

ValidStateEnum
Specifies the state value.

Declaration Syntax
public enum ValidStateEnum
Table 167: Members
Member StateInvalid

The state of the property is not


valid.

Member StateUnknown The state is unknown.


Member StateValid

246

The state of the property is valid.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Post Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Post
Table 168: Members
IComponentInfo

Exposes a result component information.

ICustomResultReader

Exposes a user customized result reader.

IResult

Exposes a result.

IResultCollector

Exposes a result collector.

IResultReader

Exposes a result reader.

IStepInfo

Exposes a step info.

ResultAveragingEnum Defines the averaging options.


ResultLocationEnum

Defines the result's location types.

ResultTypeEnum

Defines the result's types.

StepDefineByEnum

Defines the types indicating how the IStepInfo is


defined.

IComponentInfo
Exposes a result component information.

Declaration Syntax
public interface IComponentInfo
Table 169: Members
Property Name

Gets the name of the component.

Property QuantityName Gets the quantity name of the


component.
Property Unit

Gets the unit of the component.

Name
Gets the name of the component.

Declaration Syntax
public string Name { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

247

Ansys.ACT.Interfaces.Post Namespace

QuantityName
Gets the quantity name of the component.

Declaration Syntax
public string QuantityName { get; }

Unit
Gets the unit of the component.

Declaration Syntax
public string Unit { get; }

ICustomResultReader
Exposes a user customized result reader.

Declaration Syntax
public interface ICustomResultReader
Table 170: Members
Method GetComponentNames(string)

Gets the result component names for the given result


name.

Method GetComponentUnit(string, string)

Gets the result component unit for the given result name
and component name.

Method GetResultLocation(string)

Gets the result location for the given result name.

Method GetResultNames()

Gets the reader's defined result names.

Method GetResultType(string)

Gets the result type for the given result name.

Method GetStepValues()

Gets an enumerable containing the time values. The


number of steps is equal to the number of times in
returned value.

Method GetValues(string, IResultCollector)

Fills collector's values for the given result name.

Method SetCurrentStep(IStepInfo)

Sets the current step.

GetComponentNames(string)
Gets the result component names for the given result name.

Declaration Syntax
public IEnumerable<string> GetComponentNames(string resultName)

248

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ICustomResultReader

Parameters
resultName(string)
The name of the result.

GetComponentUnit(string, string)
Gets the result component unit for the given result name and component name.

Declaration Syntax
public string GetComponentUnit(string resultName, string componentName)

Parameters
resultName(string)
The result name.
componentName(string)
The component name.

GetResultLocation(string)
Gets the result location for the given result name.

Declaration Syntax
public ResultLocationEnum GetResultLocation(string resultName)

Parameters
resultName(string)
The result name.

GetResultNames()
Gets the reader's defined result names.

Declaration Syntax
public IEnumerable<string> GetResultNames()

GetResultType(string)
Gets the result type for the given result name.

Declaration Syntax
public ResultTypeEnum GetResultType(string resultName)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

249

Ansys.ACT.Interfaces.Post Namespace

Parameters
resultName(string)
The result name.

GetStepValues()
Gets an enumerable containing the time values. The number of steps is equal to the number of times
in returned value.

Declaration Syntax
public IEnumerable<double> GetStepValues()

GetValues(string, IResultCollector)
Fills collector's values for the given result name.

Declaration Syntax
public void GetValues(string resultName, IResultCollector collector)

Parameters
resultName(string)
The result name.
collector(IResultCollector)
The result collector to fill with the result's values.

SetCurrentStep(IStepInfo)
Sets the current step.

Declaration Syntax
public void SetCurrentStep(IStepInfo stepInfo)

Parameters
stepInfo(IStepInfo)
The step.

IResult
Exposes a result.

250

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IResult

Declaration Syntax
public interface IResult
Table 171: Members
Property Components

Gets the result component names.

Property Location

Gets the result location (noda, element or nodes


of element).

Property Name

Gets the result name.

Method GetComponentInfo(string)

Gets a component information.

Method GetElementValues(int)

Gets the result's element values for the given


element id.

Method GetNodeValues(int)

Gets the result's node values for the given node


id.

Method SelectComponents(IEnumerable<string>) Selects the components to read with the


GetNodeValues and GetElementValues methods.
By default, all result's components are selected.

Components
Gets the result component names.

Declaration Syntax
public IList<string> Components { get; }

Location
Gets the result location (noda, element or nodes of element).

Declaration Syntax
public ResultLocationEnum Location { get; }

Name
Gets the result name.

Declaration Syntax
public string Name { get; }

GetComponentInfo(string)
Gets a component information.

Declaration Syntax
public IComponentInfo GetComponentInfo(string component)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

251

Ansys.ACT.Interfaces.Post Namespace

Parameters
component(string)
The component name.

GetElementValues(int)
Gets the result's element values for the given element id.

Declaration Syntax
public double[] GetElementValues(int elementId)

Parameters
elementId(int)
The element id.

GetNodeValues(int)
Gets the result's node values for the given node id.

Declaration Syntax
public double[] GetNodeValues(int nodeId)

Parameters
nodeId(int)
The node id.

SelectComponents(IEnumerable<string>)
Selects the components to read with the GetNodeValues and GetElementValues methods. By default,
all result's components are selected.

Declaration Syntax
public void SelectComponents(IEnumerable<string> components)

Parameters
components(IEnumerable<string>)
The result's components.

IResultCollector
Exposes a result collector.

252

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IResultCollector

Declaration Syntax
public interface IResultCollector
Table 172: Members
Property ComponentCount

Gets the number of components per fields.

Property HasImaginary

Gets a value indicating whether the collector supports


imaginary values.

Property Ids

Gets the ids on which the collector needs results.

Property Indices

Gets the mapping array between Ids and Values.

Property Lengths

Gets all computed lenghts.

Method ContainsId(int)

Gets a value indicating whether the collector's ids


collection.

Method SetAllValues(double[])

Sets all collector's values. The values have to be in the


same order as the one defined by the Ids array.

Method SetAllValues(IEnumerable<double>) Sets all collector's values. The values have to be in the
same order as the one defined by the Ids array.
Method SetImaginaryValues(int, double[])

Sets the imaginary collector's values for the given id.

Method SetImaginaryValues(int,
IEnumerable<double>)

Sets the imaginary collector's values for the given id.

Method SetValues(int, double[])

Sets the collector's values for the given id.

Method SetValues(int,
IEnumerable<double>)

Sets the collector's values for the given id.

ComponentCount
Gets the number of components per fields.

Declaration Syntax
public int ComponentCount { get; }

HasImaginary
Gets a value indicating whether the collector supports imaginary values.

Declaration Syntax
public bool HasImaginary { get; }

Ids
Gets the ids on which the collector needs results.

Declaration Syntax
public int[] Ids { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

253

Ansys.ACT.Interfaces.Post Namespace

Indices
Gets the mapping array between Ids and Values.

Declaration Syntax
public int[] Indices { get; }

Lengths
Gets all computed lenghts.

Declaration Syntax
public int[] Lengths { get; }

ContainsId(int)
Gets a value indicating whether the collector's ids collection.

Declaration Syntax
public bool ContainsId(int id)

Parameters
id(int)
The id to check.

SetAllValues(double[])
Sets all collector's values. The values have to be in the same order as the one defined by the Ids array.

Declaration Syntax
public void SetAllValues(double[] values)

Parameters
values(double[])
The values to set.

SetAllValues(IEnumerable<double>)
Sets all collector's values. The values have to be in the same order as the one defined by the Ids array.

Declaration Syntax
public void SetAllValues(IEnumerable<double> values)

254

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IResultCollector

Parameters
values(IEnumerable<double>)
The values to set.

SetImaginaryValues(int, double[])
Sets the imaginary collector's values for the given id.

Declaration Syntax
public void SetImaginaryValues(int id, double[] values)

Parameters
id(int)
The id.
values(double[])
The values to set.

SetImaginaryValues(int, IEnumerable<double>)
Sets the imaginary collector's values for the given id.

Declaration Syntax
public void SetImaginaryValues(int id, IEnumerable<double> values)

Parameters
id(int)
The id.
values(IEnumerable<double>)
The values to set.

SetValues(int, double[])
Sets the collector's values for the given id.

Declaration Syntax
public void SetValues(int id, double[] values)

Parameters
id(int)
The id.
values(double[])
The values to set.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

255

Ansys.ACT.Interfaces.Post Namespace

SetValues(int, IEnumerable<double>)
Sets the collector's values for the given id.

Declaration Syntax
public void SetValues(int id, IEnumerable<double> values)

Parameters
id(int)
The id.
values(IEnumerable<double>)
The values to set.

IResultReader
Exposes a result reader.

Declaration Syntax
public interface IResultReader
Table 173: Members
Property CurrentResultSet

Gets or sets the current reader's resultSet.

Property CurrentTimeFreq

Gets or sets the current time/frequency value.

Property HasImaginaryResults Gets a value indicating whether the reader contains imaginary result
values.
Property ListTimeFreq

Gets the reader's defined times/frequencies.

Property ResultNames

Gets the reader's defined result names.

Property ResultSetCount

Gets the reader's resultSet count.

Method GetResult(string)

Gets a result object for given result name.

CurrentResultSet
Gets or sets the current reader's resultSet.

Declaration Syntax
public int CurrentResultSet { set;get; }

CurrentTimeFreq
Gets or sets the current time/frequency value.

Declaration Syntax
public double CurrentTimeFreq { set;get; }

256

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IStepInfo

HasImaginaryResults
Gets a value indicating whether the reader contains imaginary result values.

Declaration Syntax
public bool HasImaginaryResults { get; }

ListTimeFreq
Gets the reader's defined times/frequencies.

Declaration Syntax
public IList<double> ListTimeFreq { get; }

ResultNames
Gets the reader's defined result names.

Declaration Syntax
public IList<string> ResultNames { get; }

ResultSetCount
Gets the reader's resultSet count.

Declaration Syntax
public int ResultSetCount { get; }

GetResult(string)
Gets a result object for given result name.

Declaration Syntax
public IResult GetResult(string resultName)

Parameters
resultName(string)
The result name.

IStepInfo
Exposes a step info.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

257

Ansys.ACT.Interfaces.Post Namespace

Declaration Syntax
public interface IStepInfo
Table 174: Members
Property DefineBy Gets a value indicating how the step is
defined.
Property Set

Gets the step's set number.

Property Time

Gets the step's time.

DefineBy
Gets a value indicating how the step is defined.

Declaration Syntax
public StepDefineByEnum DefineBy { set;get; }

Set
Gets the step's set number.

Declaration Syntax
public int Set { get; }

Time
Gets the step's time.

Declaration Syntax
public double Time { get; }

ResultAveragingEnum
Defines the averaging options.

Declaration Syntax
public enum ResultAveragingEnum
Table 175: Members
Member Average

Displays averaged results.

Member ElementalDifference Computes the maximum difference between the unaveraged computed
result (for example, total heat flux, equivalent stress) for all nodes in
an element, including midside nodes.
Member ElementalFraction

258

Computes the ratio of the elemental difference and the elemental


average.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

StepDefineByEnum
Member ElementalMean

Computes the elemental average from the averaged component results.

Member NodalDifference

Computes the maximum difference between the unaveraged computed


result (for example, total heat flux, equivalent stress) for all elements
that share a particular node.

Member NodalFraction

Computes the ratio of the nodal difference and the nodal average.

Member Unaverage

Displays unaveraged results.

ResultLocationEnum
Defines the result's location types.

Declaration Syntax
public enum ResultLocationEnum
Table 176: Members
Member Element

Result defines at the elements.

Member ElementNode Result defines at the element


nodes.
Member Node

Result defines at the nodes.

ResultTypeEnum
Defines the result's types.

Declaration Syntax
public enum ResultTypeEnum
Table 177: Members
Member Scalar Scalar
result.
Member Tensor Tensor
result.
Member Vector Vector
result.

StepDefineByEnum
Defines the types indicating how the IStepInfo is defined.

Declaration Syntax
public enum StepDefineByEnum
Table 178: Members
Member Set

Specifies that the step is defined by set number.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

259

Ansys.ACT.Interfaces.Post Namespace
Member Time Specifies that the step is defined by set
time/frequency.

260

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Geometry Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Geometry
Table 179: Members
GeoBodyTypeEnum

Specifies the body type.

GeoCellTypeEnum

Specifies the geometry entity type.

GeoCurveTypeEnum

Specifies the curve type.

GeoSurfaceTypeEnum Specifies the surface type.


IBaseGeoBody

Defines generic members of a body.

IBaseGeoBodyOrPart

Defines generic members of a body.

IBaseGeoEdge

Defines generic members of an edge.

IBaseGeoEntity

Defines generic members of a geometry entity.

IBaseGeoFace

Defines generic members of a face.

IBaseGeoPart

Defines generic members of a part.

IBaseGeoVertex

Defines generic members of a vertex.

IGeoAssembly

Defines a geometry assembly.

IGeoBody

Defines additional members specific to Mechanical for a body.

IGeoData

Defines the geometry data model.

IGeoEdge

Defines additional members specific to Mechanical for an edge.

IGeoEntity

Defines additional members specific to Mechanical for a geometry


entity.

IGeoFace

Defines additional members specific to Mechanical for a face.

IGeoLoop

Defines a loop.

IGeoPart

Defines a loop.

IGeoShell

Defines a shell.

IGeoTessellation

Defines a tessellation.

IGeoVertex

Defines additional members specific to Mechanical for a vertex.

MaterialTypeEnum

Specifies the material type for the generation of the feature.

GeoBodyTypeEnum
Specifies the body type.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

261

Ansys.ACT.Interfaces.Geometry Namespace

Declaration Syntax
public enum GeoBodyTypeEnum
Table 180: Members
Member GeoBodySheet

Sheet.

Member GeoBodySolid

Solid.

Member GeoBodyUnknown Unknown


type.
Member GeoBodyWire

Wire.

GeoCellTypeEnum
Specifies the geometry entity type.

Declaration Syntax
public enum GeoCellTypeEnum
Table 181: Members
Member GeoBody

Volume.

Member GeoEdge

Edge.

Member GeoFace

Face.

Member GeoPart

Part.

Member GeoUnknown Unknown


type.
Member GeoVertex

Vertex.

GeoCurveTypeEnum
Specifies the curve type.

Declaration Syntax
public enum GeoCurveTypeEnum
Table 182: Members
Member GeoCurveBSpline

BSpline.

Member GeoCurveCircle

Circle.

Member GeoCurveCircularArc

Circular
Arc.

Member GeoCurveEllipseFull

Full
Ellipse.

Member GeoCurveEllipticalArc Elliptical


Arc.

262

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IBaseGeoBody
Member GeoCurveFaceted

Faceted
Curve.

Member GeoCurveLine

Line.

Member GeoCurveLineSegment Line


Segment.
Member GeoCurveNoGeometry No
Geometry.
Member GeoCurveUnknown

Unknown
type.

GeoSurfaceTypeEnum
Specifies the surface type.

Declaration Syntax
public enum GeoSurfaceTypeEnum
Table 183: Members
Member GeoSurfaceBSpline

BSpline.

Member GeoSurfaceCone

Cone.

Member GeoSurfaceCylinder

Cylinder.

Member GeoSurfaceEllipticalCone

Elliptical
Cone.

Member GeoSurfaceEllipticalCylinder Elliptical


Cylinder.
Member GeoSurfaceFaceted

Faceted.

Member GeoSurfaceNoGeometry

No
Geometry.

Member GeoSurfacePlane

Plane.

Member GeoSurfaceSphere

Sphere.

Member GeoSurfaceTorus

Torus.

Member GeoSurfaceUnknown

Unknown
type.

IBaseGeoBody
Defines generic members of a body.

Declaration Syntax
public interface IBaseGeoBody
Table 184: Members
Property Area

Gets the area of the body.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

263

Ansys.ACT.Interfaces.Geometry Namespace
Property BodyType Gets the body type (wire, sheet or
solid).
Property Centroid

Gets the centroid of the body.

Property Edges

Gets the list of all edges of the


body.

Property Faces

Gets the list of all faces of the body.

Property Length

Gets the length of the body.

Property Vertices

Gets the list of all vertices of the


body.

Property Volume

Gets the volume of the body.

Area
Gets the area of the body.

Declaration Syntax
public double Area { get; }

BodyType
Gets the body type (wire, sheet or solid).

Declaration Syntax
public GeoBodyTypeEnum BodyType { get; }

Centroid
Gets the centroid of the body.

Declaration Syntax
public double[] Centroid { get; }

Edges
Gets the list of all edges of the body.

Declaration Syntax
public IList<IBaseGeoEdge> Edges { get; }

Faces
Gets the list of all faces of the body.

Declaration Syntax
public IList<IBaseGeoFace> Faces { get; }

264

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IBaseGeoEdge

Length
Gets the length of the body.

Declaration Syntax
public double Length { get; }

Vertices
Gets the list of all vertices of the body.

Declaration Syntax
public IList<IBaseGeoVertex> Vertices { get; }

Volume
Gets the volume of the body.

Declaration Syntax
public double Volume { get; }

IBaseGeoBodyOrPart
Defines generic members of a body.

Declaration Syntax
public interface IBaseGeoBodyOrPart

IBaseGeoEdge
Defines generic members of an edge.

Declaration Syntax
public interface IBaseGeoEdge
Table 185: Members
Property Bodies

Gets the list of bodies of the


edge.

Property Centroid

Gets the centroid for the edge.

Property CurveType

Gets the curve type of the edge.

Property EndVertex

Gets the last vertex.

Property Faces

Gets the list of all faces of the


edge.

Property Length

Gets the length of the edge.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

265

Ansys.ACT.Interfaces.Geometry Namespace
Property StartVertex Gets the first vertex.
Property Vertices

Gets the list of all vertices of the


edge.

Bodies
Gets the list of bodies of the edge.

Declaration Syntax
public IList<IBaseGeoBody> Bodies { get; }

Centroid
Gets the centroid for the edge.

Declaration Syntax
public double[] Centroid { get; }

CurveType
Gets the curve type of the edge.

Declaration Syntax
public GeoCurveTypeEnum CurveType { get; }

EndVertex
Gets the last vertex.

Declaration Syntax
public IBaseGeoVertex EndVertex { get; }

Faces
Gets the list of all faces of the edge.

Declaration Syntax
public IList<IBaseGeoFace> Faces { get; }

Length
Gets the length of the edge.

Declaration Syntax
public double Length { get; }

266

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IBaseGeoEntity

StartVertex
Gets the first vertex.

Declaration Syntax
public IBaseGeoVertex StartVertex { get; }

Vertices
Gets the list of all vertices of the edge.

Declaration Syntax
public IList<IBaseGeoVertex> Vertices { get; }

IBaseGeoEntity
Defines generic members of a geometry entity.

Declaration Syntax
public interface IBaseGeoEntity
Table 186: Members
Property Id

Gets the reference identifier of the entity.

Property Type

Gets the cell type of the entity.

Method GetBoundingBox() Gets the bounding box of the geometry (returns


(x1,y1,z1,x2,y2,z2)).

Id
Gets the reference identifier of the entity.

Declaration Syntax
public int Id { get; }

Type
Gets the cell type of the entity.

Declaration Syntax
public GeoCellTypeEnum Type { get; }

GetBoundingBox()
Gets the bounding box of the geometry (returns (x1,y1,z1,x2,y2,z2)).

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

267

Ansys.ACT.Interfaces.Geometry Namespace

Declaration Syntax
public double[] GetBoundingBox()

IBaseGeoFace
Defines generic members of a face.

Declaration Syntax
public interface IBaseGeoFace
Table 187: Members
Property Area

Gets the area of the face.

Property Bodies

Gets the list of bodies of the face.

Property Centroid

Gets the centroid of the face.

Property Edges

Gets the list of edges of the face.

Property SurfaceType

Gets the surface type of the face.

Property Vertices

Gets the list of vertices of the face.

Method NormalAtParam(double, double)

Returns the normal vector for the given parameter values


on the face.

Method NormalsAtParams(double[])

Returns an array of normal vectors for the given set of


parameters on the face.

Method ParamAtPoint(double[])

Returns the parameter values (u,v) for the given point


on the face.

Method PointAtParam(double, double)

Returns the point for the given parameter values (u,v)


on the face.

Method PointsAtParams(double[])

Returns an array of point coordinates for the given set


of parameters on the face.

Area
Gets the area of the face.

Declaration Syntax
public double Area { get; }

Bodies
Gets the list of bodies of the face.

Declaration Syntax
public IList<IBaseGeoBody> Bodies { get; }

268

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IBaseGeoFace

Centroid
Gets the centroid of the face.

Declaration Syntax
public double[] Centroid { get; }

Edges
Gets the list of edges of the face.

Declaration Syntax
public IList<IBaseGeoEdge> Edges { get; }

SurfaceType
Gets the surface type of the face.

Declaration Syntax
public GeoSurfaceTypeEnum SurfaceType { get; }

Vertices
Gets the list of vertices of the face.

Declaration Syntax
public IList<IBaseGeoVertex> Vertices { get; }

NormalAtParam(double, double)
Returns the normal vector for the given parameter values on the face.

Declaration Syntax
public double[] NormalAtParam(double u, double v)

Parameters
u(double)
The -u- parameter component value.
v(double)
The -v- parameter component value.

NormalsAtParams(double[])
Returns an array of normal vectors for the given set of parameters on the face.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

269

Ansys.ACT.Interfaces.Geometry Namespace

Declaration Syntax
public double[] NormalsAtParams(double[] param)

Parameters
param(double[])
An array of parameters for which normals have to be returned (ordered p1u,p1v,p2u,p2v,...,pnu,pnv).

ParamAtPoint(double[])
Returns the parameter values (u,v) for the given point on the face.

Declaration Syntax
public double[] ParamAtPoint(double[] point)

Parameters
point(double[])
The coordinates (x,y,z) of the point.

PointAtParam(double, double)
Returns the point for the given parameter values (u,v) on the face.

Declaration Syntax
public double[] PointAtParam(double u, double v)

Parameters
u(double)
The -u- parameter component value.
v(double)
The -v- parameter component value.

PointsAtParams(double[])
Returns an array of point coordinates for the given set of parameters on the face.

Declaration Syntax
public double[] PointsAtParams(double[] param)

Parameters
param(double[])
An array of parameters for which points have to be returned (ordered p1u,p1v,p2u,p2v,...,pnu,pnv).

270

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IBaseGeoVertex

IBaseGeoPart
Defines generic members of a part.

Declaration Syntax
public interface IBaseGeoPart
Table 188: Members
Property Bodies Gets the list of bodies associated to the
part.
Property Name

Gets the name of the part.

Bodies
Gets the list of bodies associated to the part.

Declaration Syntax
public IList<IBaseGeoBody> Bodies { get; }

Name
Gets the name of the part.

Declaration Syntax
public string Name { get; }

IBaseGeoVertex
Defines generic members of a vertex.

Declaration Syntax
public interface IBaseGeoVertex
Table 189: Members
Property Bodies Gets the list of bodies associated to the
vertex.
Property Edges

Gets the list of edges associated to the


vertex.

Property Faces

Gets the list of faces associated to the


vertex.

Property X

Gets the X coordinate of the vertex.

Property Y

Gets the Y coordinate of the vertex.

Property Z

Gets the Z coordinate of the vertex.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

271

Ansys.ACT.Interfaces.Geometry Namespace

Bodies
Gets the list of bodies associated to the vertex.

Declaration Syntax
public IList<IBaseGeoBody> Bodies { get; }

Edges
Gets the list of edges associated to the vertex.

Declaration Syntax
public IList<IBaseGeoEdge> Edges { get; }

Faces
Gets the list of faces associated to the vertex.

Declaration Syntax
public IList<IBaseGeoFace> Faces { get; }

X
Gets the X coordinate of the vertex.

Declaration Syntax
public double X { get; }

Y
Gets the Y coordinate of the vertex.

Declaration Syntax
public double Y { get; }

Z
Gets the Z coordinate of the vertex.

Declaration Syntax
public double Z { get; }

IGeoAssembly
Defines a geometry assembly.

272

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGeoBody

Declaration Syntax
public interface IGeoAssembly
Table 190: Members
Property Dimension Gets the geometry dimension.
Property Name

Gets the name of the assembly.

Property Parts

Gets the list of parts of the


assembly.

Property Unit

Gets the length unit for the


assembly.

Dimension
Gets the geometry dimension.

Declaration Syntax
public int Dimension { get; }

Name
Gets the name of the assembly.

Declaration Syntax
public string Name { get; }

Parts
Gets the list of parts of the assembly.

Declaration Syntax
public IList<IGeoPart> Parts { get; }

Unit
Gets the length unit for the assembly.

Declaration Syntax
public string Unit { get; }

IGeoBody
Defines additional members specific to Mechanical for a body.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

273

Ansys.ACT.Interfaces.Geometry Namespace

Declaration Syntax
public interface IGeoBody
Table 191: Members
Property CrossSection

Gets or sets the beam cross section associated to the


body.

Property CrossSectionOffset

Gets or sets the beam cross section offset for the body.

Property CrossSectionOffsetType Gets or sets the beam cross section offset type for the
body.
Property Material

Gets the material associated to the body.

Property Name

Gets the name of the body.

Property Shells

Gets the list of shells associated to the body.

Property Suppressed

Gets the suppressed state of the body.

Property Thickness

Gets the thickness of the body.

CrossSection
Gets or sets the beam cross section associated to the body.

Declaration Syntax
public object CrossSection { set;get; }

CrossSectionOffset
Gets or sets the beam cross section offset for the body.

Declaration Syntax
public IEnumerable<double> CrossSectionOffset { set;get; }

CrossSectionOffsetType
Gets or sets the beam cross section offset type for the body.

Declaration Syntax
public string CrossSectionOffsetType { set;get; }

Material
Gets the material associated to the body.

Declaration Syntax
public object Material { get; }

274

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGeoData

Name
Gets the name of the body.

Declaration Syntax
public string Name { get; }

Shells
Gets the list of shells associated to the body.

Declaration Syntax
public IList<IGeoShell> Shells { get; }

Suppressed
Gets the suppressed state of the body.

Declaration Syntax
public bool Suppressed { get; }

Thickness
Gets the thickness of the body.

Declaration Syntax
public double Thickness { set;get; }

IGeoData
Defines the geometry data model.

Declaration Syntax
public interface IGeoData
Table 192: Members
Property Assemblies

Gets the list of all assemblies defines for the geometry data
model.

Method GeoEntityById(int) Returns the geometry entity referenced by the given identifier.

Assemblies
Gets the list of all assemblies defines for the geometry data model.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

275

Ansys.ACT.Interfaces.Geometry Namespace

Declaration Syntax
public IList<IGeoAssembly> Assemblies { get; }

GeoEntityById(int)
Returns the geometry entity referenced by the given identifier.

Declaration Syntax
public IGeoEntity GeoEntityById(int refId)

Parameters
refId(int)
The reference identifier of the entity.

IGeoEdge
Defines additional members specific to Mechanical for an edge.

Declaration Syntax
public interface IGeoEdge
Table 193: Members
Property CrossSectionOrientation

Gets or sets the coordinate system that defines the edge


cross section orientation.

Property Extents

Gets the parameter extents of the edge [min, max].

Property IsParamReversed

Gets a boolean that indicates if the edge orientation is


reversed or not.

Method ParamAtPoint(double[])

Returns the parameter for the given point on the edge.

Method PointAtParam(double)

Returns the point for the given parameter on the edge.

Method PointsAtParams(double[])

Returns an array of point coordinates for the given set of


parameters on the edge.

Method TangentAtParam(double)

Returns the tangent vector for the given parameter on the


edge.

Method TangentsAtParams(double[]) Returns an array of tangent vectors for the given set of
parameters on the edge.

CrossSectionOrientation
Gets or sets the coordinate system that defines the edge cross section orientation.

Declaration Syntax
public ICoordinateSystem CrossSectionOrientation { set;get; }

276

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGeoEdge

Extents
Gets the parameter extents of the edge [min, max].

Declaration Syntax
public double[] Extents { get; }

IsParamReversed
Gets a boolean that indicates if the edge orientation is reversed or not.

Declaration Syntax
public bool IsParamReversed { get; }

ParamAtPoint(double[])
Returns the parameter for the given point on the edge.

Declaration Syntax
public double ParamAtPoint(double[] point)

Parameters
point(double[])
The coordinates of the point (x, y, z).

PointAtParam(double)
Returns the point for the given parameter on the edge.

Declaration Syntax
public double[] PointAtParam(double param)

Parameters
param(double)
The parameter value.

PointsAtParams(double[])
Returns an array of point coordinates for the given set of parameters on the edge.

Declaration Syntax
public double[] PointsAtParams(double[] param)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

277

Ansys.ACT.Interfaces.Geometry Namespace

Parameters
param(double[])
An array of parameters for which points have to be returned (ordered p1,p2,...,pn).

TangentAtParam(double)
Returns the tangent vector for the given parameter on the edge.

Declaration Syntax
public double[] TangentAtParam(double param)

Parameters
param(double)
The parameter value.

TangentsAtParams(double[])
Returns an array of tangent vectors for the given set of parameters on the edge.

Declaration Syntax
public double[] TangentsAtParams(double[] param)

Parameters
param(double[])
An array of parameters for which tangents have to be returned (ordered p1,p2,...,pn).

IGeoEntity
Defines additional members specific to Mechanical for a geometry entity.

Declaration Syntax
public interface IGeoEntity
Table 194: Members
Property Part Gets the part associated to the geometry
entity.

Part
Gets the part associated to the geometry entity.

Declaration Syntax
public IGeoPart Part { get; }

278

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGeoLoop

IGeoFace
Defines additional members specific to Mechanical for a face.

Declaration Syntax
public interface IGeoFace
Table 195: Members
Property Loops Gets the list of loops associated to the
face.
Property Shell

Gets the shell associated to the face.

Loops
Gets the list of loops associated to the face.

Declaration Syntax
public IList<IGeoLoop> Loops { get; }

Shell
Gets the shell associated to the face.

Declaration Syntax
public IGeoShell Shell { get; }

IGeoLoop
Defines a loop.

Declaration Syntax
public interface IGeoLoop
Table 196: Members
Property Edges Gets the list of edges associated to the
loop.
Property Face

Gets the face associated to the loop.

Edges
Gets the list of edges associated to the loop.

Declaration Syntax
public IList<IGeoEdge> Edges { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

279

Ansys.ACT.Interfaces.Geometry Namespace

Face
Gets the face associated to the loop.

Declaration Syntax
public IGeoFace Face { get; }

IGeoPart
Defines a loop.

Declaration Syntax
public interface IGeoPart

IGeoShell
Defines a shell.

Declaration Syntax
public interface IGeoShell
Table 197: Members
Property Faces Gets the list of faces associated to the
face.

Faces
Gets the list of faces associated to the face.

Declaration Syntax
public IList<IGeoFace> Faces { get; }

IGeoTessellation
Defines a tessellation.

Declaration Syntax
public interface IGeoTessellation
Table 198: Members
Property FacetCount Gets the number of facets.
Property Indices

Gets an array of indices. (Ordered n1,i1_1,i1_2,...,i1_n1, n2,i2_1,i2_2,...i2_n2,


...).

Property Normals

Gets an array of normal vectors. (Ordered x1,y1,z1,x2,y2,z2,...,xn,yn,zn).

280

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

MaterialTypeEnum
Property Points

Gets an array of point coordinates. (Ordered x1,y1,z1,x2,y2,z2,...,xn,yn,zn).

FacetCount
Gets the number of facets.

Declaration Syntax
public int FacetCount { get; }

Indices
Gets an array of indices. (Ordered n1,i1_1,i1_2,...,i1_n1, n2,i2_1,i2_2,...i2_n2, ...).

Declaration Syntax
public int[] Indices { get; }

Normals
Gets an array of normal vectors. (Ordered x1,y1,z1,x2,y2,z2,...,xn,yn,zn).

Declaration Syntax
public double[] Normals { get; }

Points
Gets an array of point coordinates. (Ordered x1,y1,z1,x2,y2,z2,...,xn,yn,zn).

Declaration Syntax
public double[] Points { get; }

IGeoVertex
Defines additional members specific to Mechanical for a vertex.

Declaration Syntax
public interface IGeoVertex

MaterialTypeEnum
Specifies the material type for the generation of the feature.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

281

Ansys.ACT.Interfaces.Geometry Namespace

Declaration Syntax
public enum MaterialTypeEnum
Table 199: Members
Member Add

Add.

Member Cut

Cut.

Member Freeze Freeze.


Member Imprint Imprint.
Member Slice

282

Slice.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.UserInterface Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.UserInterface
Table 200: Members
EntryTypeEnum

Specifies the entry type.

IEntry

Defines an entry in a toolbar.


The object behind this interface could be any type of UI Component: buttons,
separators, etc.

INamed

Defines an object with a name.

INamedCollection<T> Defines a collection of named objects.


IToolbar

Defines a toolbar.

IUserInterface

Defines a user interface.

EntryTypeEnum
Specifies the entry type.

Declaration Syntax
public enum EntryTypeEnum
Table 201: Members
Member Button

Button.

Member Dropdown Dropdown.


Member Separator Separator.

IEntry
Defines an entry in a toolbar.
The object behind this interface could be any type of UI Component: buttons, separators, etc.

Declaration Syntax
public interface IEntry
Table 202: Members
Property Caption

Gets the caption of the entry.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

283

Ansys.ACT.Interfaces.UserInterface Namespace
Property Checked

Gets or sets the checked flag.

Property Enabled

Gets or sets the enabled flag.

Property Entries

Gets the list of child entries.

Property EntryType Gets the type of the entry.


Property Visible

Gets or sets the visibility of the


entry.

Caption
Gets the caption of the entry.

Declaration Syntax
public string Caption { get; }

Checked
Gets or sets the checked flag.

Declaration Syntax
public bool Checked { set;get; }

Enabled
Gets or sets the enabled flag.

Declaration Syntax
public bool Enabled { set;get; }

Entries
Gets the list of child entries.

Declaration Syntax
public INamedCollection<IEntry> Entries { get; }

EntryType
Gets the type of the entry.

Declaration Syntax
public EntryTypeEnum EntryType { get; }

Visible
Gets or sets the visibility of the entry.

284

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

INamedCollection<T>

Declaration Syntax
public bool Visible { set;get; }

INamed
Defines an object with a name.

Declaration Syntax
public interface INamed
Table 203: Members
Property Name Gets the name of the
object.

Name
Gets the name of the object.

Declaration Syntax
public string Name { get; }

INamedCollection<T>
Defines a collection of named objects.

Declaration Syntax
public interface INamedCollection<T>
Table 204: Members
Property Item

Gets the object given by its name.

Property Names Gets the list of the names of the objects in the
collection.

Item
Gets the object given by its name.

Declaration Syntax
public T Item { get; }

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

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

285

Ansys.ACT.Interfaces.UserInterface Namespace

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

IToolbar
Defines a toolbar.

Declaration Syntax
public interface IToolbar
Table 205: Members
Property Caption Gets the caption of the toolbar.
Property Entries

Gets the collection of entries.

Property Visible

Gets or sets the visibility of the


toolbar.

Caption
Gets the caption of the toolbar.

Declaration Syntax
public string Caption { get; }

Entries
Gets the collection of entries.

Declaration Syntax
public INamedCollection<IEntry> Entries { get; }

Visible
Gets or sets the visibility of the toolbar.

Declaration Syntax
public bool Visible { set;get; }

IUserInterface
Defines a user interface.

286

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserInterface

Declaration Syntax
public interface IUserInterface
Table 206: Members
Property IsBatchMode

Gets the batch mode of the user interface.

Property Toolbars

Gets the collection of toolbars.

Method GetExtensionToolbars(IExtension) Returns the toolbars defined by a given


extension.

IsBatchMode
Gets the batch mode of the user interface.

Declaration Syntax
public bool IsBatchMode { get; }

Toolbars
Gets the collection of toolbars.

Declaration Syntax
public ReadOnlyCollection<IToolbar> Toolbars { get; }

GetExtensionToolbars(IExtension)
Returns the toolbars defined by a given extension.

Declaration Syntax
public INamedCollection<IToolbar> GetExtensionToolbars(IExtension extension)

Parameters
extension(IExtension)
No details are provided for this entry.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

287

288

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Graphics
Table 207: Members
ICamera

Camera.

IDraw2DContext

Exposes a context to draw 2D features.

IDraw3DContext

Exposes a context to draw 3D features.

IDrawContext

Exposes a graphics context.

IFactory2D

Exposes a factory to create 2D graphics


entitities.

IFactory3D

Factory to create 3D primitives

IGraphics

Exposes graphics features.

IGraphicsCollection Exposes a collection of graphics entities.


IPixelPoint

Exposes a pixel point.

IPoint

Exposes a point.

ISuspendController Exposes a scene suspend controller.


ITransformable

Exposes a transformable entity.

ITransformation3D

Exposes a 3D transformation.

IVector3D

Exposes a 3D vector.

IWorldPoint

Exposes a world point.

ICamera
Camera.

Declaration Syntax
public interface ICamera
Table 208: Members
Property ZoomFactor

Gets or sets the zoom


factor.

Method GetLocation() Gets the position of the


camera.
Method GetTarget()

Gets the target of the


camera.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

289

Ansys.ACT.Interfaces.Graphics Namespace

ZoomFactor
Gets or sets the zoom factor.

Declaration Syntax
public double ZoomFactor { set;get; }

GetLocation()
Gets the position of the camera.

Declaration Syntax
public IWorldPoint GetLocation()

GetTarget()
Gets the target of the camera.

Declaration Syntax
public IWorldPoint GetTarget()

IDraw2DContext
Exposes a context to draw 2D features.

Declaration Syntax
public interface IDraw2DContext
Table 209: Members
Method Clear()

Clear the context.

Method DrawText2D(IPoint, string)

Draws text at the given point.

Method DrawText2D(int, int, string)

Draws text at the given x and y pixel coordinates.

Method LineTo2D(IPoint)

Draws a line from the current position to the given point.

Method LineTo2D(int, int)

Draws a line from the current position to the given x and y


pixel coordinates.

Method MoveTo2D(IPoint)

Moves the pencil to the given point.

Method MoveTo2D(int, int)

Moves the pencil to the given x and y pixel coordinates.

Clear()
Clear the context.

Declaration Syntax
public void Clear()

290

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IDraw2DContext

DrawText2D(IPoint, string)
Draws text at the given point.

Declaration Syntax
public void DrawText2D(IPoint point, string text)

Parameters
point(IPoint)
The text coordinates.
text(string)
The text to draw.

DrawText2D(int, int, string)


Draws text at the given x and y pixel coordinates.

Declaration Syntax
public void DrawText2D(int x, int y, string text)

Parameters
x(int)
The x coordinate.
y(int)
The y coordinate.
text(string)
The text to display.

LineTo2D(IPoint)
Draws a line from the current position to the given point.

Declaration Syntax
public void LineTo2D(IPoint point)

Parameters
point(IPoint)
The point.

LineTo2D(int, int)
Draws a line from the current position to the given x and y pixel coordinates.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

291

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public void LineTo2D(int x, int y)

Parameters
x(int)
The x coordinate.
y(int)
The y coordinate.

MoveTo2D(IPoint)
Moves the pencil to the given point.

Declaration Syntax
public void MoveTo2D(IPoint point)

Parameters
point(IPoint)
The point.

MoveTo2D(int, int)
Moves the pencil to the given x and y pixel coordinates.

Declaration Syntax
public void MoveTo2D(int x, int y)

Parameters
x(int)
The x coordinate.
y(int)
The y coordinate.

IDraw3DContext
Exposes a context to draw 3D features.

Declaration Syntax
public interface IDraw3DContext
Table 210: Members
Method Close()

292

Closes and draw this context. Except for the


visibility, a closed context cannot be modified.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IDraw3DContext
Method DrawCircle(IEnumerable<double>, double, Draws a circle using the current color and line
IEnumerable<double>)
weight.
Method DrawDisc(IEnumerable<double>, double,
IEnumerable<double>)

Draws a disc using the current color and line


weight.

Method DrawPoints(IEnumerable<double>)

Draws a set of points using the current color


and line weight.

Method DrawPoints(IEnumerable<double>,
double)

Draws a set of points with the current color.

Method DrawPolygon(IEnumerable<double>,
IEnumerable<double>)

Draws a polygon using the current color and


line weight.

Method DrawPolyline(IEnumerable<double>, bool) Draws a polyline using the current color and
line weight.
Method DrawShell(IEnumerable<double>,
Draws a surface defined by a set of faces (three
IEnumerable<double>, IEnumerable<int>) or four vertices per face). This function can be
called directly using the information given by
the IGeoTessellation interface.
Method DrawShell(IEnumerable<double>,
Draws a surface defined by a set of faces (three
IEnumerable<double>, IEnumerable<int>, or four vertices per face). This function can be
IEnumerable<int>)
called directly using the information given by
the IGeoTessellation interface.
Method SetTransformation(double[])

Sets the transformation.

Close()
Closes and draw this context. Except for the visibility, a closed context cannot be modified.

Declaration Syntax
public void Close()

DrawCircle(IEnumerable<double>, double, IEnumerable<double>)


Draws a circle using the current color and line weight.

Declaration Syntax
public void DrawCircle(IEnumerable<double> center, double radius, IEnumerable<double> normal)

Parameters
center(IEnumerable<double>)
The circle center coordinates.
radius(double)
The circle radius.
normal(IEnumerable<double>)
A vector indicating the axis of the circle.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

293

Ansys.ACT.Interfaces.Graphics Namespace

DrawDisc(IEnumerable<double>, double, IEnumerable<double>)


Draws a disc using the current color and line weight.

Declaration Syntax
public void DrawDisc(IEnumerable<double> center, double radius, IEnumerable<double> normal)

Parameters
center(IEnumerable<double>)
The disk center coordinates.
radius(double)
The disk radius.
normal(IEnumerable<double>)
A vector indicating the axis of the disk.

DrawPoints(IEnumerable<double>)
Draws a set of points using the current color and line weight.

Declaration Syntax
public void DrawPoints(IEnumerable<double> points)

Parameters
points(IEnumerable<double>)
The points coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].

DrawPoints(IEnumerable<double>, double)
Draws a set of points with the current color.

Declaration Syntax
public void DrawPoints(IEnumerable<double> points, double size)

Parameters
points(IEnumerable<double>)
The points coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
size(double)
The points size.

DrawPolygon(IEnumerable<double>, IEnumerable<double>)
Draws a polygon using the current color and line weight.

294

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IDraw3DContext

Declaration Syntax
public void DrawPolygon(IEnumerable<double> points, IEnumerable<double> normals)

Parameters
points(IEnumerable<double>)
The points coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
normals(IEnumerable<double>)
The points normals. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].

DrawPolyline(IEnumerable<double>, bool)
Draws a polyline using the current color and line weight.

Declaration Syntax
public void DrawPolyline(IEnumerable<double> points, bool isClosed)

Parameters
points(IEnumerable<double>)
The points coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
isClosed(bool)
A value indicating whether the polyline is closed.

DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>)


Draws a surface defined by a set of faces (three or four vertices per face). This function can be called
directly using the information given by the IGeoTessellation interface.

Declaration Syntax
public void DrawShell(IEnumerable<double> vertices, IEnumerable<double> normals, IEnumerable<int>
faces)

Parameters
vertices(IEnumerable<double>)
Array of points coordinates.
normals(IEnumerable<double>)
Array of vectors (one vector per vertex).
faces(IEnumerable<int>)
Array of Indices to describe each face. One face is defined by an integer (three or four) that identify the
number of vertices for this face and the index of each vertex.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

295

Ansys.ACT.Interfaces.Graphics Namespace

DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>,


IEnumerable<int>)
Draws a surface defined by a set of faces (three or four vertices per face). This function can be called
directly using the information given by the IGeoTessellation interface.

Declaration Syntax
public void DrawShell(IEnumerable<double> vertices, IEnumerable<double> normals, IEnumerable<int>
faces, IEnumerable<int> colors)

Parameters
vertices(IEnumerable<double>)
Array of points coordinates.
normals(IEnumerable<double>)
Array of vectors (one vector per vertex).
faces(IEnumerable<int>)
Array of Indices to describe each face. One face is defined by an integer (three or four) that identify the
number of vertices for this face and the index of each vertex.
colors(IEnumerable<int>)
Array of colors (one color per vertex).

SetTransformation(double[])
Sets the transformation.

Declaration Syntax
public void SetTransformation(double[] transformation)

Parameters
transformation(double[])
The matrix transformation.

IDrawContext
Exposes a graphics context.

Declaration Syntax
public interface IDrawContext
Table 211: Members
Property Color

296

Gets or sets the color. (0xff0000 for red, 0x00ff00 for green, and 0x0000ff for
blue).

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IFactory2D
Property DepthTest

Gets or sets a value indicating whether the depth has to be used to compute
the visibility.

Property LineWeight

Gets or sets the line weight.

Property Translucency Gets or sets the translucency.


Property Visible

Gets or sets a value indicating whether the context is visible.

Color
Gets or sets the color. (0xff0000 for red, 0x00ff00 for green, and 0x0000ff for blue).

Declaration Syntax
public int Color { set;get; }

DepthTest
Gets or sets a value indicating whether the depth has to be used to compute the visibility.

Declaration Syntax
public bool DepthTest { set;get; }

LineWeight
Gets or sets the line weight.

Declaration Syntax
public int LineWeight { set;get; }

Translucency
Gets or sets the translucency.

Declaration Syntax
public double Translucency { set;get; }

Visible
Gets or sets a value indicating whether the context is visible.

Declaration Syntax
public bool Visible { set;get; }

IFactory2D
Exposes a factory to create 2D graphics entitities.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

297

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public interface IFactory2D
Table 212: Members
Method CreatePolyline()

Creates a
polyline.

Method CreatePolyline(IEnumerable<IPoint>) Creates a


polyline.
Method CreateText()

Ceate a text.

Method CreateText(IPoint, string)

Ceate a text.

CreatePolyline()
Creates a polyline.

Declaration Syntax
public IPolyline<IPoint> CreatePolyline()

CreatePolyline(IEnumerable<IPoint>)
Creates a polyline.

Declaration Syntax
public IPolyline<IPoint> CreatePolyline(IEnumerable<IPoint> points)

Parameters
points(IEnumerable<IPoint>)
The points constituting the polyline.

CreateText()
Ceate a text.

Declaration Syntax
public IText2D CreateText()

CreateText(IPoint, string)
Ceate a text.

Declaration Syntax
public IText2D CreateText(IPoint origin, string text)

298

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IFactory3D

Parameters
origin(IPoint)
The text origin.
text(string)
The text to display.

IFactory3D
Factory to create 3D primitives

Declaration Syntax
public interface IFactory3D
Table 213: Members
Method CreateArrow(double)

Create an arrow.

Method CreateArrow(double, double, double,


double)

Create an arrow

Method CreateBox(double, double, double)

Create a box from (0, 0, 0) to (x, y, z).

Method CreateCircle(double)

Create a circle centered in (0, 0, 0) oriented by


(0, 0, 1).

Method CreateCone(double, double)

Create a cone with top radius equals to 0.

Method CreateCone(double, double, double)

Create a cone.

Method CreateCylinder(double, double)

Create a cylinder.

Method CreateDisc(double)

Create a disc centered in (0, 0, 0) oriented by (0,


0, 1).

Method CreateGeometry(IGeoEntity)

Create a non pickable geometry object based


on geometry entity.

Method CreateMesh(IElement)

Create a non pickable mesh object based on a


mesh element.

Method CreateMesh(IEnumerable<IElement>)

Create a non pickable mesh object based on


mesh elements.

Method CreateMesh(IMeshData)

Create a non pickable mesh object based on a


mesh data.

Method CreateMesh(IMeshRegion)

Create a non pickable mesh object based on a


mesh region.

Method CreateNodeBox(IEnumerable<INode>)

Create a box collection surrounding mesh nodes.

Method CreateNodeBox(INode)

Create a box surrounding a mesh node.

Method CreateNodeBox(IEnumerable<INode>,
double)

Create a box collection surrounding mesh nodes.

Method CreateNodeBox(INode, double)

Create a box surrounding a mesh node.

Method CreatePoint()

Create a point in (0, 0, 0).

Method CreatePoint(IEnumerable<IWorldPoint>,
double)

Create multiple points.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

299

Ansys.ACT.Interfaces.Graphics Namespace
Method CreatePoint(IWorldPoint, double)

Create a point.

Method CreatePolyline()

Create a polyline.

Method CreatePolyline(IEnumerable<IWorldPoint>) Create a polyline.


Method CreateQuad(double, double)

Create a quad from (0, 0, 0) to (x, y, 0).

Method CreateShell()

Create a shell.

Method CreateShell(IEnumerable<double>,
Create a shell
IEnumerable<double>, IEnumerable<int>)
Method CreateShell(IEnumerable<double>,
Create a shell
IEnumerable<double>, IEnumerable<int>,
IEnumerable<int>)
Method CreateSphere(double)

Create a sphere centered in (0, 0, 0).

Method CreateTriad(double)

Create a triad. A triad is a collection of 3 arrows


respectivly oriented along the x, y and z axis.

CreateArrow(double)
Create an arrow.

Declaration Syntax
public IArrow3D CreateArrow(double length)

Parameters
length(double)
The arrow length.

CreateArrow(double, double, double, double)


Create an arrow

Declaration Syntax
public IArrow3D CreateArrow(double bodyLength, double headLength, double bodyRadius, double
headRadius)

Parameters
bodyLength(double)
The arrow body length.
headLength(double)
The arrow head length.
bodyRadius(double)
The arrow body radius.
headRadius(double)
The arrow head radius.

300

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IFactory3D

CreateBox(double, double, double)


Create a box from (0, 0, 0) to (x, y, z).

Declaration Syntax
public IBox3D CreateBox(double x, double y, double z)

Parameters
x(double)
The size along the x axis.
y(double)
The size along the y axis.
z(double)
The size along the z axis.

CreateCircle(double)
Create a circle centered in (0, 0, 0) oriented by (0, 0, 1).

Declaration Syntax
public ICircle3D CreateCircle(double radius)

Parameters
radius(double)
The circle radius.

CreateCone(double, double)
Create a cone with top radius equals to 0.

Declaration Syntax
public ICone3D CreateCone(double length, double bottomRadius)

Parameters
length(double)
The cone length.
bottomRadius(double)
The cone bottom radius.

CreateCone(double, double, double)


Create a cone.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

301

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public ICone3D CreateCone(double length, double bottomRadius, double topRadius)

Parameters
length(double)
The cone length.
bottomRadius(double)
The cone bottom radius.
topRadius(double)
The cone top radius.

CreateCylinder(double, double)
Create a cylinder.

Declaration Syntax
public ICone3D CreateCylinder(double length, double radius)

Parameters
length(double)
The cylinder length.
radius(double)
The cylinder radius.

CreateDisc(double)
Create a disc centered in (0, 0, 0) oriented by (0, 0, 1).

Declaration Syntax
public IDisc3D CreateDisc(double radius)

Parameters
radius(double)
The disc radius.

CreateGeometry(IGeoEntity)
Create a non pickable geometry object based on geometry entity.

Declaration Syntax
public IGeometry3D CreateGeometry(IGeoEntity geometry)

302

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IFactory3D

Parameters
geometry(IGeoEntity)
The geometry entity.

CreateMesh(IElement)
Create a non pickable mesh object based on a mesh element.

Declaration Syntax
public IMesh3D CreateMesh(IElement element)

Parameters
element(IElement)
The mesh element.

CreateMesh(IEnumerable<IElement>)
Create a non pickable mesh object based on mesh elements.

Declaration Syntax
public IMesh3D CreateMesh(IEnumerable<IElement> elements)

Parameters
elements(IEnumerable<IElement>)
The mesh elements.

CreateMesh(IMeshData)
Create a non pickable mesh object based on a mesh data.

Declaration Syntax
public IMesh3D CreateMesh(IMeshData mesh)

Parameters
mesh(IMeshData)
The mesh data.

CreateMesh(IMeshRegion)
Create a non pickable mesh object based on a mesh region.

Declaration Syntax
public IMesh3D CreateMesh(IMeshRegion region)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

303

Ansys.ACT.Interfaces.Graphics Namespace

Parameters
region(IMeshRegion)
The mesh region.

CreateNodeBox(IEnumerable<INode>)
Create a box collection surrounding mesh nodes.

Declaration Syntax
public INodeBox3D CreateNodeBox(IEnumerable<INode> nodes)

Parameters
nodes(IEnumerable<INode>)
The surrounded mesh nodes.

CreateNodeBox(INode)
Create a box surrounding a mesh node.

Declaration Syntax
public INodeBox3D CreateNodeBox(INode node)

Parameters
node(INode)
The surrounded mesh node.

CreateNodeBox(IEnumerable<INode>, double)
Create a box collection surrounding mesh nodes.

Declaration Syntax
public INodeBox3D CreateNodeBox(IEnumerable<INode> nodes, double size)

Parameters
nodes(IEnumerable<INode>)
The surrounded mesh nodes.
size(double)
The boxes size.

CreateNodeBox(INode, double)
Create a box surrounding a mesh node.

304

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IFactory3D

Declaration Syntax
public INodeBox3D CreateNodeBox(INode node, double size)

Parameters
node(INode)
The surrounded mesh node.
size(double)
The box size.

CreatePoint()
Create a point in (0, 0, 0).

Declaration Syntax
public IPoint3D CreatePoint()

CreatePoint(IEnumerable<IWorldPoint>, double)
Create multiple points.

Declaration Syntax
public IPoint3D CreatePoint(IEnumerable<IWorldPoint> points, double size)

Parameters
points(IEnumerable<IWorldPoint>)
The point locations.
size(double)
The point sizes.

CreatePoint(IWorldPoint, double)
Create a point.

Declaration Syntax
public IPoint3D CreatePoint(IWorldPoint point, double size)

Parameters
point(IWorldPoint)
The point location.
size(double)
The point size .

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

305

Ansys.ACT.Interfaces.Graphics Namespace

CreatePolyline()
Create a polyline.

Declaration Syntax
public IPolyline<IWorldPoint> CreatePolyline()

CreatePolyline(IEnumerable<IWorldPoint>)
Create a polyline.

Declaration Syntax
public IPolyline<IWorldPoint> CreatePolyline(IEnumerable<IWorldPoint> points)

Parameters
points(IEnumerable<IWorldPoint>)
The points constituting the polyline.

CreateQuad(double, double)
Create a quad from (0, 0, 0) to (x, y, 0).

Declaration Syntax
public IQuad3D CreateQuad(double x, double y)

Parameters
x(double)
The size along the x axis.
y(double)
The size along the y axis.

CreateShell()
Create a shell.

Declaration Syntax
public IShell3D CreateShell()

CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>)


Create a shell

Declaration Syntax
public IShell3D CreateShell(IEnumerable<double> vertices, IEnumerable<double> normals, IEnumerable<int> connectivity)
306

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IFactory3D

Parameters
vertices(IEnumerable<double>)
The vertex coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
normals(IEnumerable<double>)
The vertex normals. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
connectivity(IEnumerable<int>)
The facets connectivity. The connectivity defines the triangles constituting the shell, it should match the
following format [I1, J1, K1, I2, J2, K2, ...], where I, J and K are index of vertex coordinates.

CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>,


IEnumerable<int>)
Create a shell

Declaration Syntax
public IShell3D CreateShell(IEnumerable<double> vertices, IEnumerable<double> normals, IEnumerable<int> connectivity, IEnumerable<int> colors)

Parameters
vertices(IEnumerable<double>)
The vertex coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
normals(IEnumerable<double>)
The vertex normals. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
connectivity(IEnumerable<int>)
The facets connectivity. The connectivity defines the triangles constituting the shell, it should match the
following format [I1, J1, K1, I2, J2, K2, ...], where I, J and K are index of vertex coordinates.
colors(IEnumerable<int>)
The vertex colors. The values should match the following format [C1, C2, C3, ...].

CreateSphere(double)
Create a sphere centered in (0, 0, 0).

Declaration Syntax
public ISphere3D CreateSphere(double radius)

Parameters
radius(double)
The sphere radius.

CreateTriad(double)
Create a triad. A triad is a collection of 3 arrows respectivly oriented along the x, y and z axis.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

307

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public ITriad3D CreateTriad(double length)

Parameters
length(double)
The arrows length.

IGraphics
Exposes graphics features.

Declaration Syntax
public interface IGraphics
Table 214: Members
Property Camera

Gets the camera.

Property Scene

Gets the scene.

Property Unit

Gets the current graphics unit.

Method CreatePixelPoint(int, int)

Creates a point from pixel coordinates (ie. window


coordinates).

Method CreateVector3D(double, double,


double)

Create a 3D vector from world coordinates.

Method CreateWorldPoint(double, double,


double)

Create a point from world coordinates.

Method ForceResume()

Forces the scene to resume. Useful in interactive


context (console) if a reference on an operation has
been lost.

Method Redraw()

Forces the scene to redraw its content.

Method Suspend()

Prevents the scene to redraw until the Resume


controller method was called.

Camera
Gets the camera.

Declaration Syntax
public ICamera Camera { get; }

Scene
Gets the scene.

Declaration Syntax
public IGraphicsCollection Scene { get; }

308

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGraphics

Unit
Gets the current graphics unit.

Declaration Syntax
public string Unit { get; }

CreatePixelPoint(int, int)
Creates a point from pixel coordinates (ie. window coordinates).

Declaration Syntax
public IPixelPoint CreatePixelPoint(int x, int y)

Parameters
x(int)
The x coordinate.
y(int)
The y coordinate.

CreateVector3D(double, double, double)


Create a 3D vector from world coordinates.

Declaration Syntax
public IVector3D CreateVector3D(double x, double y, double z)

Parameters
x(double)
The x coordinate.
y(double)
The y coordinate.
z(double)
The z coordinate.

CreateWorldPoint(double, double, double)


Create a point from world coordinates.

Declaration Syntax
public IWorldPoint CreateWorldPoint(double x, double y, double z)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

309

Ansys.ACT.Interfaces.Graphics Namespace

Parameters
x(double)
The x coordinate.
y(double)
The y coordinate.
z(double)
The z coordinate.

ForceResume()
Forces the scene to resume. Useful in interactive context (console) if a reference on an operation has
been lost.

Declaration Syntax
public void ForceResume()

Redraw()
Forces the scene to redraw its content.

Declaration Syntax
public void Redraw()

Suspend()
Prevents the scene to redraw until the Resume controller method was called.

Declaration Syntax
public ISuspendController Suspend()

IGraphicsCollection
Exposes a collection of graphics entities.

Declaration Syntax
public interface IGraphicsCollection
Table 215: Members
Property Entities

Gets the collection's entities.

Property Factory2D

Gets the 2D entity builder.

Property Factory3D

Gets the 3D entity builder.

Method Clear()

Removes all entities from the collection.

Method CreateChildCollection()

Creates a new child collection.

310

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGraphicsCollection
Method Remove(IGraphicsCollection) Removes one collection from the
collection.
Method Remove(IGraphicsEntity)

Removes one entity from the collection.

Entities
Gets the collection's entities.

Declaration Syntax
public IList<IGraphicsEntity> Entities { get; }

Factory2D
Gets the 2D entity builder.

Declaration Syntax
public IFactory2D Factory2D { get; }

Factory3D
Gets the 3D entity builder.

Declaration Syntax
public IFactory3D Factory3D { get; }

Clear()
Removes all entities from the collection.

Declaration Syntax
public void Clear()

CreateChildCollection()
Creates a new child collection.

Declaration Syntax
public IGraphicsCollection CreateChildCollection()

Remove(IGraphicsCollection)
Removes one collection from the collection.

Declaration Syntax
public void Remove(IGraphicsCollection collection)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

311

Ansys.ACT.Interfaces.Graphics Namespace

Parameters
collection(IGraphicsCollection)
The collection to remove.

Remove(IGraphicsEntity)
Removes one entity from the collection.

Declaration Syntax
public void Remove(IGraphicsEntity graphicsEntity)

Parameters
graphicsEntity(IGraphicsEntity)
The entity to remove.

IPixelPoint
Exposes a pixel point.

Declaration Syntax
public interface IPixelPoint
Table 216: Members
Property X

Gets or sets the x


coordinate.

Property Y

Gets or sets the y


coordinate.

Method Set(int,
int)

Sets the x and y


coordinates.

X
Gets or sets the x coordinate.

Declaration Syntax
public int X { set;get; }

Y
Gets or sets the y coordinate.

Declaration Syntax
public int Y { set;get; }

312

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IPoint

Set(int, int)
Sets the x and y coordinates.

Declaration Syntax
public void Set(int x, int y)

Parameters
x(int)
The x coordinate.
y(int)
The y coordinate.

IPoint
Exposes a point.

Declaration Syntax
public interface IPoint
Table 217: Members
Event

Changed

Event fired when the point's coordinates were


modified.

Method Clone()

Clones the point.

Method ToPixelPoint()

Converts the point to a pixel point.

Method ToWorldPoint()

Converts the point to a world point.

Changed
Event fired when the point's coordinates were modified.

Declaration Syntax
public EventHandler Changed

Clone()
Clones the point.

Declaration Syntax
public IPoint Clone()

ToPixelPoint()
Converts the point to a pixel point.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

313

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public IPixelPoint ToPixelPoint()

ToWorldPoint()
Converts the point to a world point.

Declaration Syntax
public IWorldPoint ToWorldPoint()

ISuspendController
Exposes a scene suspend controller.

Declaration Syntax
public interface ISuspendController
Table 218: Members
Method Resume() Allow the scene to redraw its content if it has changed. This method is
automaticaly called by the controller Dispose method.

Resume()
Allow the scene to redraw its content if it has changed. This method is automaticaly called by the
controller Dispose method.

Declaration Syntax
public void Resume()

ITransformable
Exposes a transformable entity.

Declaration Syntax
public interface ITransformable
Table 219: Members
Property Transformation3D Gets the 3D transformation
object.

Transformation3D
Gets the 3D transformation object.

314

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ITransformation3D

Declaration Syntax
public ITransformation3D Transformation3D { get; }

ITransformation3D
Exposes a 3D transformation.

Declaration Syntax
public interface ITransformation3D
Table 220: Members
Property Item

Gets the [row, column] value of the 4x4 transformation


matrix.

Property Scale

Gets or sets the scale factor.

Method Reset()

Resets the transformation matrix to identity.

Method Rotate(IVector3D, double)

Applies a rotation centered in (0, 0, 0) around the given


axis.

Method Set(double[])

Sets transformation matrix from a one dimensional array.

Method Set(IWorldPoint)

Sets the translation components to the given origin and


the rotation ones to identity.

Method Set(IWorldPoint, IVector3D)

Sets the translation components to the given origin and


align the z axis along the given normal.

Method Set(IWorldPoint, IVector3D,


IVector3D)

Sets the translation components to the given origin and


sets the x and y axis using given vectors. Z axis is the
cross product between x and y.

Method Set(IWorldPoint, IVector3D,


IVector3D, IVector3D)

Sets the translation components to the given origin and


sets the x, y and z axis using given vectors.

Method ToArray()

Converts the internal transformation matrix into a one


dimensional array.

Method Translate(IVector3D)

Applies a translation.

Method Translate(double, double,


double)

Applies a translation given by offset values.

Item
Gets the [row, column] value of the 4x4 transformation matrix.

Declaration Syntax
public double Item { get; }

Scale
Gets or sets the scale factor.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

315

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public double Scale { set;get; }

Reset()
Resets the transformation matrix to identity.

Declaration Syntax
public void Reset()

Rotate(IVector3D, double)
Applies a rotation centered in (0, 0, 0) around the given axis.

Declaration Syntax
public void Rotate(IVector3D direction, double angle)

Parameters
direction(IVector3D)
The normalized rotation direction.
angle(double)
The rotation angle in radian.

Set(double[])
Sets transformation matrix from a one dimensional array.

Declaration Syntax
public void Set(double[] transformation)

Parameters
transformation(double[])
The 4x4 transformation matrix.

Set(IWorldPoint)
Sets the translation components to the given origin and the rotation ones to identity.

Declaration Syntax
public void Set(IWorldPoint origin)

Parameters
origin(IWorldPoint)
The origin.
316

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ITransformation3D

Set(IWorldPoint, IVector3D)
Sets the translation components to the given origin and align the z axis along the given normal.

Declaration Syntax
public void Set(IWorldPoint origin, IVector3D normal)

Parameters
origin(IWorldPoint)
The origin.
normal(IVector3D)
The normal vector.

Set(IWorldPoint, IVector3D, IVector3D)


Sets the translation components to the given origin and sets the x and y axis using given vectors. Z
axis is the cross product between x and y.

Declaration Syntax
public void Set(IWorldPoint origin, IVector3D vectorX, IVector3D vectorY)

Parameters
origin(IWorldPoint)
The origin.
vectorX(IVector3D)
The X vector.
vectorY(IVector3D)
The Y vector.

Set(IWorldPoint, IVector3D, IVector3D, IVector3D)


Sets the translation components to the given origin and sets the x, y and z axis using given vectors.

Declaration Syntax
public void Set(IWorldPoint origin, IVector3D vectorX, IVector3D vectorY, IVector3D vectorZ)

Parameters
origin(IWorldPoint)
The origin.
vectorX(IVector3D)
The X vector.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

317

Ansys.ACT.Interfaces.Graphics Namespace
vectorY(IVector3D)
The Y vector.
vectorZ(IVector3D)
The Z vector.

ToArray()
Converts the internal transformation matrix into a one dimensional array.

Declaration Syntax
public double[] ToArray()

Translate(IVector3D)
Applies a translation.

Declaration Syntax
public void Translate(IVector3D translation)

Parameters
translation(IVector3D)
The translation vector.

Translate(double, double, double)


Applies a translation given by offset values.

Declaration Syntax
public void Translate(double x, double y, double z)

Parameters
x(double)
The x translation offset.
y(double)
The y translation offset.
z(double)
The z translation offset.

IVector3D
Exposes a 3D vector.

318

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IVector3D

Declaration Syntax
public interface IVector3D
Table 221: Members
Property X

Gets or sets the x component.

Property Y

Gets or sets the y component.

Property Z

Gets or sets the z component.

Method CrossProduct(IVector3D)

Computes the cross product betwen the current vector


and the given one.

Method GetNormal()

Computes a random normal vector.

Method IsColinearTo(IVector3D)

Gets a value indicating whether the current vector is


colinear to the given one.

Method IsColinearTo(IVector3D, double)

Gets a value indicating whether the current vector is


colinear to the given one, using the given precision.

Method Length()

Computes vector length.

Method Normalize()

Normalizes the vector.

Method SquareLength()

Computes vector squared length.

X
Gets or sets the x component.

Declaration Syntax
public double X { set;get; }

Y
Gets or sets the y component.

Declaration Syntax
public double Y { set;get; }

Z
Gets or sets the z component.

Declaration Syntax
public double Z { set;get; }

CrossProduct(IVector3D)
Computes the cross product betwen the current vector and the given one.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

319

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public IVector3D CrossProduct(IVector3D other)

Parameters
other(IVector3D)
The other vector.

GetNormal()
Computes a random normal vector.

Declaration Syntax
public IVector3D GetNormal()

IsColinearTo(IVector3D)
Gets a value indicating whether the current vector is colinear to the given one.

Declaration Syntax
public bool IsColinearTo(IVector3D other)

Parameters
other(IVector3D)
The other vector.

IsColinearTo(IVector3D, double)
Gets a value indicating whether the current vector is colinear to the given one, using the given precision.

Declaration Syntax
public bool IsColinearTo(IVector3D other, double precision)

Parameters
other(IVector3D)
The other vector.
precision(double)
The algorithm precision.

Length()
Computes vector length.

Declaration Syntax
public double Length()
320

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IWorldPoint

Normalize()
Normalizes the vector.

Declaration Syntax
public void Normalize()

SquareLength()
Computes vector squared length.

Declaration Syntax
public double SquareLength()

IWorldPoint
Exposes a world point.

Declaration Syntax
public interface IWorldPoint
Table 222: Members
Property X Gets or sets the x
component.
Property Y Gets or sets the y
component.
Property Z Gets or sets the z
component.

X
Gets or sets the x component.

Declaration Syntax
public double X { set;get; }

Y
Gets or sets the y component.

Declaration Syntax
public double Y { set;get; }

Z
Gets or sets the z component.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

321

Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public double Z { set;get; }

322

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.DataModel Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.DataModel
Table 223: Members
IDataModelObject Defines a data model
object.

IDataModelObject
Defines a data model object.

Declaration Syntax
public interface IDataModelObject
Table 224: Members
Property ObjectLocation

Gets the location of the object within his


parent.

Property ObjectType

Gets the type of the object.

Property Parent

Gets the parent object.

Property SupportedLocations Gets the locations supported by the object.

ObjectLocation
Gets the location of the object within his parent.

Declaration Syntax
public ObjectLocationEnum ObjectLocation { get; }

ObjectType
Gets the type of the object.

Declaration Syntax
public ObjectTypeEnum ObjectType { get; }

Parent
Gets the parent object.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

323

Ansys.ACT.Interfaces.DataModel Namespace

Declaration Syntax
public IDataModelObject Parent { get; }

SupportedLocations
Gets the locations supported by the object.

Declaration Syntax
public ObjectLocationEnum[] SupportedLocations { get; }

324

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Wizard Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Wizard
Table 225: Members
IStepUserInterface Defines a list of properties and methods to customize the user interface of a
wizard's step.
IWizard

Defines a wizard.

IWizardStep

Defines a step of a wizard.

IStepUserInterface
Defines a list of properties and methods to customize the user interface of a wizard's step.

Declaration Syntax
public interface IStepUserInterface
Table 226: Members
Property ContentPanelSizes

Gets or sets the percentage size of each area for the content
panel.

Property CustomPanelControl No details are provided for this entry.


Property HtmlContent

No details are provided for this entry.

Property HtmlContentFile

No details are provided for this entry.

Method NotifyChange()

No details are provided for this entry.

ContentPanelSizes
Gets or sets the percentage size of each area for the content panel.

Declaration Syntax
public string ContentPanelSizes { set;get; }

CustomPanelControl
No details are provided for this entry.

Declaration Syntax
public object CustomPanelControl { set;get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

325

Ansys.ACT.Interfaces.Wizard Namespace

HtmlContent
No details are provided for this entry.

Declaration Syntax
public string HtmlContent { set;get; }

HtmlContentFile
No details are provided for this entry.

Declaration Syntax
public string HtmlContentFile { set;get; }

NotifyChange()
No details are provided for this entry.

Declaration Syntax
public void NotifyChange()

IWizard
Defines a wizard.

Declaration Syntax
public interface IWizard
Table 227: Members
Property Author

Gets the author of the wizard.

Property CurrentStep

Gets the current step.

Property Description

Gets the description of the wizard.

Property ExtensionName Gets the associated extension to the


wizard.
Property Filename

Gets the filename of the wizard.

Property Folder

Gets the folder.

Property Name

Gets the name of the wizard.

Property Steps

Gets all steps.

Author
Gets the author of the wizard.

326

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IWizard

Declaration Syntax
public string Author { get; }

CurrentStep
Gets the current step.

Declaration Syntax
public IWizardStep CurrentStep { get; }

Description
Gets the description of the wizard.

Declaration Syntax
public string Description { get; }

ExtensionName
Gets the associated extension to the wizard.

Declaration Syntax
public string ExtensionName { get; }

Filename
Gets the filename of the wizard.

Declaration Syntax
public string Filename { get; }

Folder
Gets the folder.

Declaration Syntax
public string Folder { get; }

Name
Gets the name of the wizard.

Declaration Syntax
public string Name { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

327

Ansys.ACT.Interfaces.Wizard Namespace

Steps
Gets all steps.

Declaration Syntax
public IDictionary<string, IWizardStep> Steps { get; }

IWizardStep
Defines a step of a wizard.

Declaration Syntax
public interface IWizardStep
Table 228: Members
Property ComponentName Gets or sets the name of the associated
component.
Property NextStep

Gets the next step.

Property PreviousStep

Gets the previous step.

Property StepId

Gets or sets the name of the associated


component.

Property SystemName

Gets or sets the name of the associated system.

Property UserInterface

Gets the user interface object.

Property Wizard

Gets the associated wizard.

ComponentName
Gets or sets the name of the associated component.

Declaration Syntax
public string ComponentName { set;get; }

NextStep
Gets the next step.

Declaration Syntax
public IWizardStep NextStep { get; }

PreviousStep
Gets the previous step.

Declaration Syntax
public IWizardStep PreviousStep { get; }
328

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IWizardStep

StepId
Gets or sets the name of the associated component.

Declaration Syntax
public int StepId { get; }

SystemName
Gets or sets the name of the associated system.

Declaration Syntax
public string SystemName { set;get; }

UserInterface
Gets the user interface object.

Declaration Syntax
public IStepUserInterface UserInterface { get; }

Wizard
Gets the associated wizard.

Declaration Syntax
public IWizard Wizard { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

329

330

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Graphics.Entities Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Graphics.Entities
Table 229: Members
IArrow3D

Arrow 3D.

IBox3D

Box 3D.

ICircle3D

Circle 3D.

ICone3D

Cone 3D.

IDisc3D

Disc 3D.

IGeometry3D

Geometry 3D. Represents a non pickable geometry object.

IGraphicsEntity Exposes a graphics entity.


IMesh3D

Mesh 3D. Represents a non pickable mesh object.

INodeBox3D

NodeBox 3D. Represents a box collection surrounding mesh


nodes.

IPoint3D

Point 3D. Represents a collection of points.

IPolyline<T>

Polyline.

IQuad3D

Quad 3D.

IShell3D

Shell 3D.

ISphere3D

Sphere 3D.

IText2D

Text 2D.

ITriad3D

Triad 3D.

IArrow3D
Arrow 3D.

Declaration Syntax
public interface IArrow3D
Table 230: Members
Property Body

Returns the body of the arrow.

Property BodyLength Gets or sets the length of the body of the


arrow.
Property BodyRadius

Gets or sets the radius of the body of the


arrow.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

331

Ansys.ACT.Interfaces.Graphics.Entities Namespace
Property Head

Returns the head of the arrow.

Property HeadLength Gets or sets the length of the head of the


arrow.
Property HeadRadius

Gets or sets the radius of the head of the


arrow.

Property Length

Gets or sets the full length of the arrow.

Body
Returns the body of the arrow.

Declaration Syntax
public ICone3D Body { get; }

BodyLength
Gets or sets the length of the body of the arrow.

Declaration Syntax
public double BodyLength { set;get; }

BodyRadius
Gets or sets the radius of the body of the arrow.

Declaration Syntax
public double BodyRadius { set;get; }

Head
Returns the head of the arrow.

Declaration Syntax
public ICone3D Head { get; }

HeadLength
Gets or sets the length of the head of the arrow.

Declaration Syntax
public double HeadLength { set;get; }

HeadRadius
Gets or sets the radius of the head of the arrow.

332

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IBox3D

Declaration Syntax
public double HeadRadius { set;get; }

Length
Gets or sets the full length of the arrow.

Declaration Syntax
public double Length { set;get; }

IBox3D
Box 3D.

Declaration Syntax
public interface IBox3D
Table 231: Members
Property X Gets or sets the size of the box along the
x axis.
Property Y Gets or sets the size of the box along the
y axis.
Property Z Gets or sets the size of the box along the
z axis.

X
Gets or sets the size of the box along the x axis.

Declaration Syntax
public double X { set;get; }

Y
Gets or sets the size of the box along the y axis.

Declaration Syntax
public double Y { set;get; }

Z
Gets or sets the size of the box along the z axis.

Declaration Syntax
public double Z { set;get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

333

Ansys.ACT.Interfaces.Graphics.Entities Namespace

ICircle3D
Circle 3D.

Declaration Syntax
public interface ICircle3D
Table 232: Members
Property Radius Gets or sets the radius of the
circle.

Radius
Gets or sets the radius of the circle.

Declaration Syntax
public double Radius { set;get; }

ICone3D
Cone 3D.

Declaration Syntax
public interface ICone3D
Table 233: Members
Property BottomRadius Gets or sets the bottom radius of the cone.
Property Closed

Gets or sets a value indicating whether the face at the top and at the bottom
are displayed.

Property Length

Gets or sets the length of the cone.

Property Samples

Gets or sets the number of divisions for the top and the botton circles. The
default value is 16.

Property TopRadius

Gets or sets the top radius of the cone.

BottomRadius
Gets or sets the bottom radius of the cone.

Declaration Syntax
public double BottomRadius { set;get; }

Closed
Gets or sets a value indicating whether the face at the top and at the bottom are displayed.

334

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGeometry3D

Declaration Syntax
public bool Closed { set;get; }

Length
Gets or sets the length of the cone.

Declaration Syntax
public double Length { set;get; }

Samples
Gets or sets the number of divisions for the top and the botton circles. The default value is 16.

Declaration Syntax
public int Samples { set;get; }

TopRadius
Gets or sets the top radius of the cone.

Declaration Syntax
public double TopRadius { set;get; }

IDisc3D
Disc 3D.

Declaration Syntax
public interface IDisc3D
Table 234: Members
Property Radius Gets or sets the radius of the
disc.

Radius
Gets or sets the radius of the disc.

Declaration Syntax
public double Radius { set;get; }

IGeometry3D
Geometry 3D. Represents a non pickable geometry object.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

335

Ansys.ACT.Interfaces.Graphics.Entities Namespace

Declaration Syntax
public interface IGeometry3D
Table 235: Members
Property DisplayEdge

Indicates if edges have to be


displayed.

Property DisplayFace

Indicates if faces have to be


displayed.

Property DisplayVertex Indicates if vertices have to be


displayed.
Property EdgeColor

Gets or sets the edges color.

Property FaceColor

Gets or sets the faces color.

Property VertexColor

Gets or sets the vertices color.

Property VertexSize

Gets or sets the vertices size.

DisplayEdge
Indicates if edges have to be displayed.

Declaration Syntax
public bool DisplayEdge { set;get; }

DisplayFace
Indicates if faces have to be displayed.

Declaration Syntax
public bool DisplayFace { set;get; }

DisplayVertex
Indicates if vertices have to be displayed.

Declaration Syntax
public bool DisplayVertex { set;get; }

EdgeColor
Gets or sets the edges color.

Declaration Syntax
public int EdgeColor { set;get; }

336

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IGraphicsEntity

FaceColor
Gets or sets the faces color.

Declaration Syntax
public int FaceColor { set;get; }

VertexColor
Gets or sets the vertices color.

Declaration Syntax
public int VertexColor { set;get; }

VertexSize
Gets or sets the vertices size.

Declaration Syntax
public double VertexSize { set;get; }

IGraphicsEntity
Exposes a graphics entity.

Declaration Syntax
public interface IGraphicsEntity
Table 236: Members
Property Color

Gets or sets the color. (0xff0000 for red, 0x00ff00 for green, and 0x0000ff for
blue).

Property DepthTest

Gets or sets a value indicating whether the depth has to be used to compute
the visibility.

Property Is2D

Gets a value indicating whether the entity is 2D.

Property Is3D

Gets a value indicating whether the entity is 3D.

Property LineWeight

Gets or sets the line weight.

Property Translucency Gets or sets the translucency.


Property Visible

Gets or sets a value indicating whether the entity is visible.

Method Delete()

Delete the entity.

Color
Gets or sets the color. (0xff0000 for red, 0x00ff00 for green, and 0x0000ff for blue).

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

337

Ansys.ACT.Interfaces.Graphics.Entities Namespace

Declaration Syntax
public int Color { set;get; }

DepthTest
Gets or sets a value indicating whether the depth has to be used to compute the visibility.

Declaration Syntax
public bool DepthTest { set;get; }

Is2D
Gets a value indicating whether the entity is 2D.

Declaration Syntax
public bool Is2D { get; }

Is3D
Gets a value indicating whether the entity is 3D.

Declaration Syntax
public bool Is3D { get; }

LineWeight
Gets or sets the line weight.

Declaration Syntax
public int LineWeight { set;get; }

Translucency
Gets or sets the translucency.

Declaration Syntax
public double Translucency { set;get; }

Visible
Gets or sets a value indicating whether the entity is visible.

Declaration Syntax
public bool Visible { set;get; }

338

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IPoint3D

Delete()
Delete the entity.

Declaration Syntax
public void Delete()

IMesh3D
Mesh 3D. Represents a non pickable mesh object.

Declaration Syntax
public interface IMesh3D

INodeBox3D
NodeBox 3D. Represents a box collection surrounding mesh nodes.

Declaration Syntax
public interface INodeBox3D
Table 237: Members
Property Size Gets or sets the size of the
box.

Size
Gets or sets the size of the box.

Declaration Syntax
public double Size { set;get; }

IPoint3D
Point 3D. Represents a collection of points.

Declaration Syntax
public interface IPoint3D
Table 238: Members
Property Points Gets the list of points.
Property Size

Gets or sets the size of the


points.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

339

Ansys.ACT.Interfaces.Graphics.Entities Namespace

Points
Gets the list of points.

Declaration Syntax
public IList<IWorldPoint> Points { get; }

Size
Gets or sets the size of the points.

Declaration Syntax
public double Size { set;get; }

IPolyline<T>
Polyline.

Declaration Syntax
public interface IPolyline<T>
Table 239: Members
Property Closed

Gets or sets a value indicating whether the polyline is


colsed.

Property EndPoint

Gets the end point.

Property Length

Gets the length of the polyline.

Property Points

Gets the list of points constituting the polyline.

Property StartPoint Gets the start point.

Closed
Gets or sets a value indicating whether the polyline is colsed.

Declaration Syntax
public bool Closed { set;get; }

EndPoint
Gets the end point.

Declaration Syntax
public T EndPoint { get; }

340

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IQuad3D

Length
Gets the length of the polyline.

Declaration Syntax
public double Length { get; }

Points
Gets the list of points constituting the polyline.

Declaration Syntax
public IList<T> Points { get; }

StartPoint
Gets the start point.

Declaration Syntax
public T StartPoint { get; }

IQuad3D
Quad 3D.

Declaration Syntax
public interface IQuad3D
Table 240: Members
Property X Gets or sets the size of the quad along the
x axis.
Property Y Gets or sets the size of the quad along the
y axis.

X
Gets or sets the size of the quad along the x axis.

Declaration Syntax
public double X { set;get; }

Y
Gets or sets the size of the quad along the y axis.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

341

Ansys.ACT.Interfaces.Graphics.Entities Namespace

Declaration Syntax
public double Y { set;get; }

IShell3D
Shell 3D.

Declaration Syntax
public interface IShell3D
Table 241: Members
Property Colors

Gets the colors.

Property Connectivity

Gets the connectivity.

Property HasColors

Gets a value indicating whether colors are


defined.

Property Initialized

Gets a value indicating whether the shell is


initialized.

Property Normals

Gets the normals.

Property TriangleCount

Gets the facets count.

Property Vertices

Gets the vertices.

Method SetAttributes(IEnumerable<double>,
IEnumerable<double>, IEnumerable<int>)

Sets all needed attributes to build the shell.

Method SetAttributes(IEnumerable<double>,
IEnumerable<double>, IEnumerable<int>,
IEnumerable<int>)

Sets all needed attributes to build the shell,


including the vertice colors.

Colors
Gets the colors.

Declaration Syntax
public IEnumerable<int> Colors { get; }

Connectivity
Gets the connectivity.

Declaration Syntax
public IEnumerable<int> Connectivity { get; }

HasColors
Gets a value indicating whether colors are defined.

342

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IShell3D

Declaration Syntax
public bool HasColors { get; }

Initialized
Gets a value indicating whether the shell is initialized.

Declaration Syntax
public bool Initialized { get; }

Normals
Gets the normals.

Declaration Syntax
public IEnumerable<double> Normals { get; }

TriangleCount
Gets the facets count.

Declaration Syntax
public int TriangleCount { get; }

Vertices
Gets the vertices.

Declaration Syntax
public IEnumerable<double> Vertices { get; }

SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>)


Sets all needed attributes to build the shell.

Declaration Syntax
public void SetAttributes(IEnumerable<double> vertices, IEnumerable<double> normals, IEnumerable<int>
connectivity)

Parameters
vertices(IEnumerable<double>)
The vertex coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

343

Ansys.ACT.Interfaces.Graphics.Entities Namespace
normals(IEnumerable<double>)
The vertex normals. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
connectivity(IEnumerable<int>)
The facets connectivity. The connectivity defines the triangles constituting the shell, it should match the
following format [I1, J1, K1, I2, J2, K2, ...], where I, J and K are index of vertex coordinates.

SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumerable<int>)


Sets all needed attributes to build the shell, including the vertice colors.

Declaration Syntax
public void SetAttributes(IEnumerable<double> vertices, IEnumerable<double> normals, IEnumerable<int>
connectivity, IEnumerable<int> colors)

Parameters
vertices(IEnumerable<double>)
The vertex coordinates. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
normals(IEnumerable<double>)
The vertex normals. The values should match the following format [X1, Y1, Z1, X2, Y2, Z2, ...].
connectivity(IEnumerable<int>)
The facets connectivity. The connectivity defines the triangles constituting the shell, it should match the
following format [I1, J1, K1, I2, J2, K2, ...], where I, J and K are index of vertex coordinates.
colors(IEnumerable<int>)
The vertex colors. The values should match the following format [C1, C2, C3, ...].

ISphere3D
Sphere 3D.

Declaration Syntax
public interface ISphere3D
Table 242: Members
Property Radius

Gets or sets the radius of the sphere.

Property Samples Gets or sets the number of divisions along all directions. The default value
is 16.

Radius
Gets or sets the radius of the sphere.

Declaration Syntax
public double Radius { set;get; }
344

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ITriad3D

Samples
Gets or sets the number of divisions along all directions. The default value is 16.

Declaration Syntax
public int Samples { set;get; }

IText2D
Text 2D.

Declaration Syntax
public interface IText2D
Table 243: Members
Property Origin Gets or sets the origin coordinates of the
text.
Property Text

Gets or sets the text value.

Origin
Gets or sets the origin coordinates of the text.

Declaration Syntax
public IPoint Origin { set;get; }

Text
Gets or sets the text value.

Declaration Syntax
public string Text { set;get; }

ITriad3D
Triad 3D.

Declaration Syntax
public interface ITriad3D
Table 244: Members
Property Length

Gets or sets the length of the


triad.

Property XArrow Gets the X arrow.


Property YArrow

Gets the Y arrow.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

345

Ansys.ACT.Interfaces.Graphics.Entities Namespace
Property ZArrow Gets the Z arrow.

Length
Gets or sets the length of the triad.

Declaration Syntax
public double Length { set; }

XArrow
Gets the X arrow.

Declaration Syntax
public IArrow3D XArrow { get; }

YArrow
Gets the Y arrow.

Declaration Syntax
public IArrow3D YArrow { get; }

ZArrow
Gets the Z arrow.

Declaration Syntax
public IArrow3D ZArrow { get; }

346

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Common Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Common
Table 245: Members
IAttributeCollection Defines a collection of
attributes.
IExtension

Defines an extension.

IExtensionManager

Defines an extension
manager.

ILog

Defines log engine.

IParameter

Defines a design parameter.

IParameterManager Defines a parameter


manager.
ISelectionInfo

Defines a selection
information.

ISelectionManager

Defines a selection
manager.

ITools

Defines common tools.

SelectionTypeEnum Specifies the selection type.

IAttributeCollection
Defines a collection of attributes.

Declaration Syntax
public interface IAttributeCollection
Table 246: Members
Property Item

Gets or sets the value of the attribute identified by its name.

Property Keys

Gets the list of attribute names.

Method Contains(string)

Checks if the collection contains the attribute identified by its


name.

Method GetStringValue(string)

Returns the string value of the attribute identified by its name.

Method GetValue(string)

Returns the value of the attribute identified by its name.

Method GetValue(string, object) Returns the value of the attribute identified by its name.
Method Remove(string)

Removes the attribute identified by its name.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

347

Ansys.ACT.Interfaces.Common Namespace
Method SetValue(string, object)

Sets the value of an attribute identified by its name.

Item
Gets or sets the value of the attribute identified by its name.

Declaration Syntax
public object Item { set;get; }

Keys
Gets the list of attribute names.

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

Contains(string)
Checks if the collection contains the attribute identified by its name.

Declaration Syntax
public bool Contains(string name)

Parameters
name(string)
The attribute name.

GetStringValue(string)
Returns the string value of the attribute identified by its name.

Declaration Syntax
public string GetStringValue(string name)

Parameters
name(string)
The name of the attribute.

GetValue(string)
Returns the value of the attribute identified by its name.

Declaration Syntax
public object GetValue(string name)

348

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IExtension

Parameters
name(string)
The name of the attribute.

GetValue(string, object)
Returns the value of the attribute identified by its name.

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

Parameters
name(string)
The name of the attribute.
defaultValue(object)
The default value

Remove(string)
Removes the attribute identified by its name.

Declaration Syntax
public bool Remove(string name)

Parameters
name(string)
The name of the attribute.

SetValue(string, object)
Sets the value of an attribute identified by its name.

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

Parameters
name(string)
The name of the attribute.
value(object)
The value of the attrbiute.

IExtension
Defines an extension.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

349

Ansys.ACT.Interfaces.Common Namespace

Declaration Syntax
public interface IExtension
Table 247: Members
Property InstallDir

Gets the folder where the extension is


installed.

Property MinorVersion Gets the minor version of the extension.


Property Name

Gets the name of the extension.

Property UniqueId

Gets the unique identifier of the extension.

Property Version

Gets the version of the extension.

InstallDir
Gets the folder where the extension is installed.

Declaration Syntax
public string InstallDir { get; }

MinorVersion
Gets the minor version of the extension.

Declaration Syntax
public int MinorVersion { get; }

Name
Gets the name of the extension.

Declaration Syntax
public string Name { get; }

UniqueId
Gets the unique identifier of the extension.

Declaration Syntax
public string UniqueId { get; }

Version
Gets the version of the extension.

350

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ILog

Declaration Syntax
public int Version { get; }

IExtensionManager
Defines an extension manager.

Declaration Syntax
public interface IExtensionManager
Table 248: Members
Property CurrentExtension Gets the current extension.
Property Extensions

Gets the list of loaded


extensions.

CurrentExtension
Gets the current extension.

Declaration Syntax
public IExtension CurrentExtension { get; }

Extensions
Gets the list of loaded extensions.

Declaration Syntax
public IList<IExtension> Extensions { get; }

ILog
Defines log engine.

Declaration Syntax
public interface ILog
Table 249: Members
Method ViewLog()

Displays the log.

Method WriteError(string)

Adds a new error message entry into the


log.

Method WriteMessage(string) Adds a new message entry into the log.


Method WriteWarning(string)

Adds a new warning message entry into the


log.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

351

Ansys.ACT.Interfaces.Common Namespace

ViewLog()
Displays the log.

Declaration Syntax
public void ViewLog()

WriteError(string)
Adds a new error message entry into the log.

Declaration Syntax
public void WriteError(string message)

Parameters
message(string)
The error message.

WriteMessage(string)
Adds a new message entry into the log.

Declaration Syntax
public void WriteMessage(string message)

Parameters
message(string)
The message.

WriteWarning(string)
Adds a new warning message entry into the log.

Declaration Syntax
public void WriteWarning(string message)

Parameters
message(string)
The warning message.

IParameter
Defines a design parameter.

352

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISelectionInfo

Declaration Syntax
public interface IParameter
Table 250: Members
Property Key

Gets the identifier of the


parameter.

Property Name Gets the name of the


parameter.
Property Value

Gets the value of the


parameter.

Key
Gets the identifier of the parameter.

Declaration Syntax
public string Key { get; }

Name
Gets the name of the parameter.

Declaration Syntax
public string Name { get; }

Value
Gets the value of the parameter.

Declaration Syntax
public double Value { get; }

IParameterManager
Defines a parameter manager.

Declaration Syntax
public interface IParameterManager

ISelectionInfo
Defines a selection information.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

353

Ansys.ACT.Interfaces.Common Namespace

Declaration Syntax
public interface ISelectionInfo
Table 251: Members
Property Id

Gets the selection


identifier.

Property Ids

Gets or sets selected IDs.

Property Name

Gets or sets the selection


name.

Property SelectionType Gets or sets the selection


type.

Id
Gets the selection identifier.

Declaration Syntax
public int Id { get; }

Ids
Gets or sets selected IDs.

Declaration Syntax
public IList<int> Ids { set;get; }

Name
Gets or sets the selection name.

Declaration Syntax
public string Name { set;get; }

SelectionType
Gets or sets the selection type.

Declaration Syntax
public SelectionTypeEnum SelectionType { set;get; }

ISelectionManager
Defines a selection manager.

354

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISelectionManager

Declaration Syntax
public interface ISelectionManager
Table 252: Members
Property CurrentSelection

Gets the current selection.

Method AddSelection(ISelectionInfo)

Adds a new selection to the current selection.

Method ClearSelection()

Clears the current selection.

Method CreateSelectionInfo(SelectionTypeEnum) Creates a new selection information based on its


type.
Method NewSelection(ISelectionInfo)

Creates a new selection.

CurrentSelection
Gets the current selection.

Declaration Syntax
public ISelectionInfo CurrentSelection { get; }

AddSelection(ISelectionInfo)
Adds a new selection to the current selection.

Declaration Syntax
public void AddSelection(ISelectionInfo info)

Parameters
info(ISelectionInfo)
The selection.

ClearSelection()
Clears the current selection.

Declaration Syntax
public void ClearSelection()

CreateSelectionInfo(SelectionTypeEnum)
Creates a new selection information based on its type.

Declaration Syntax
public ISelectionInfo CreateSelectionInfo(SelectionTypeEnum selectionType)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

355

Ansys.ACT.Interfaces.Common Namespace

Parameters
selectionType(SelectionTypeEnum)
The type of the selection.

NewSelection(ISelectionInfo)
Creates a new selection.

Declaration Syntax
public void NewSelection(ISelectionInfo info)

Parameters
info(ISelectionInfo)
The selection.

ITools
Defines common tools.

Declaration Syntax
public interface ITools
Table 253: Members
Method GetGeoDataFromFile(string)

Returns the geo data model object for the CAD file
name specified.

Method GetMeshDataFromFile(string, string)

Returns the mesh data model associated to the file


name specified.

Method GetResultsDataFromFile(string)

Returns the result reader object associated to the file


name specified.

GetGeoDataFromFile(string)
Returns the geo data model object for the CAD file name specified.

Declaration Syntax
public IGeoData GetGeoDataFromFile(string filename)

Parameters
filename(string)
The name of the geometry file.

GetMeshDataFromFile(string, string)
Returns the mesh data model associated to the file name specified.

356

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

SelectionTypeEnum

Declaration Syntax
public IMeshData GetMeshDataFromFile(string filename, string bodyGrouping)

Parameters
filename(string)
The name of the mesh file.
bodyGrouping(string)
When the mesh is imported, bodies can be created for the following filters: none (default), component,
material, thickness, type

GetResultsDataFromFile(string)
Returns the result reader object associated to the file name specified.

Declaration Syntax
public IResultReader GetResultsDataFromFile(string filename)

Parameters
filename(string)
The name of the results file.

SelectionTypeEnum
Specifies the selection type.

Declaration Syntax
public enum SelectionTypeEnum
Table 254: Members
Member GeometryEntities All selected items will be IDs of geometry
entities.
Member MeshElements

All selected items will be element IDs.

Member MeshNodes

All selected items will be node IDs.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

357

358

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Analysis Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Analysis
Table 255: Members
CoordinateSystemTypeEnum Specifies the coordinate system type.
IAnalysis

Defines an analysis.

ICoordinateSystem

Defines a coordinate system.

IDataObject

Defines an object of the application data model.

IDataObjectCollection

Defines a collection of objects of the application data


model.

IDataObjectContainer

Defines a container of objects.

ISolverData

Defines the data associated to a specfied solve type.

SolveTypeEnum

Specifies the type of solve.

CoordinateSystemTypeEnum
Specifies the coordinate system type.

Declaration Syntax
public enum CoordinateSystemTypeEnum
Table 256: Members
Member Cartesian Cartesian coordinate
system.
Member Cylindrical Cylindrical coordinate
system.
Member Spherical Spherical coordinate
system.

IAnalysis
Defines an analysis.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

359

Ansys.ACT.Interfaces.Analysis Namespace

Declaration Syntax
public interface IAnalysis
Table 257: Members
Property AnalysisType

Gets the analysis type.

Property Components

Gets all components (named selections).

Property CoordinateSystems

Gets all coordinate systems.

Property GeoData

Gets access to the geometry data model


associated to the analysis.

Property Id

Gets the ID for this analysis.

Property LoadObjects

Gets all ACT load objects associated to


the analysis.

Property MeshData

Gets access to the mesh data model


associated to the analysis.

Property Name

Gets the name of the analysis.

Property PhysicsType

Gets the physics type.

Property PropertyNames

Gets the list of property names.

Property ResultObjects

Gets all ACT result objects associated to


the analysis.

Property Solver

Gets the ACT solver object associated


with this analysis if exists or null.

Property SolverName

Gets the solver name for this analysis.

Property StepsEndTime

Gets the list of steps end times defined.

Property UserObjects

Gets all ACT objects associated to the


analysis.

Property WorkingDir

Gets the working directory.

Method ComponentById(int)

Returns a component (named selection)


by its ID.

Method CoordinateSystemById(int)

Returns a coordinate system object by its


ID.

Method CreateLoadObject(string)

Creates a new load object.

Method CreatePostObject(string)

Creates a new post object.

Method CreateResultObject(string)

Creates a new result object.

Method CurrentConsistentUnitFromQuantityName(string) Returns the current consistent unit from


a quantity name.
Method GenerateMesh()

Generates the mesh of the analysis.

Method GetResultsData()

Returns the result reader associated to


the analysis.

Method PropertyValue(string)

Returns the value of the property that


matches the specified name.

Method PropertyValue(string, object)

Assigns the given value to the property


that matches the specified name.

360

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IAnalysis
Method Solve(bool)

Computes the analysis solution.

Method WriteInputFile(string)

Writes the input file associated to the


analysis.

AnalysisType
Gets the analysis type.

Declaration Syntax
public string AnalysisType { get; }

Components
Gets all components (named selections).

Declaration Syntax
public IList<ISelectionInfo> Components { get; }

CoordinateSystems
Gets all coordinate systems.

Declaration Syntax
public IList<ICoordinateSystem> CoordinateSystems { get; }

GeoData
Gets access to the geometry data model associated to the analysis.

Declaration Syntax
public IGeoData GeoData { get; }

Id
Gets the ID for this analysis.

Declaration Syntax
public int Id { get; }

LoadObjects
Gets all ACT load objects associated to the analysis.

Declaration Syntax
public IEnumerable<IUserLoad> LoadObjects { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

361

Ansys.ACT.Interfaces.Analysis Namespace

MeshData
Gets access to the mesh data model associated to the analysis.

Declaration Syntax
public IMeshData MeshData { get; }

Name
Gets the name of the analysis.

Declaration Syntax
public string Name { get; }

PhysicsType
Gets the physics type.

Declaration Syntax
public string PhysicsType { get; }

PropertyNames
Gets the list of property names.

Declaration Syntax
public IList<string> PropertyNames { get; }

ResultObjects
Gets all ACT result objects associated to the analysis.

Declaration Syntax
public IEnumerable<IUserResult> ResultObjects { get; }

Solver
Gets the ACT solver object associated with this analysis if exists or null.

Declaration Syntax
public IUserSolver Solver { get; }

SolverName
Gets the solver name for this analysis.

362

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IAnalysis

Declaration Syntax
public string SolverName { get; }

StepsEndTime
Gets the list of steps end times defined.

Declaration Syntax
public IList<double> StepsEndTime { get; }

UserObjects
Gets all ACT objects associated to the analysis.

Declaration Syntax
public IEnumerable<IUserObject> UserObjects { get; }

WorkingDir
Gets the working directory.

Declaration Syntax
public string WorkingDir { get; }

ComponentById(int)
Returns a component (named selection) by its ID.

Declaration Syntax
public ISelectionInfo ComponentById(int id)

Parameters
id(int)
The ID of the component.

CoordinateSystemById(int)
Returns a coordinate system object by its ID.

Declaration Syntax
public ICoordinateSystem CoordinateSystemById(int id)

Parameters
id(int)
The ID of the coordinate system.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

363

Ansys.ACT.Interfaces.Analysis Namespace

CreateLoadObject(string)
Creates a new load object.

Declaration Syntax
public IUserLoad CreateLoadObject(string objName)

Parameters
objName(string)
The name of the load object. This name must be one of the name of object created in the xml extension
file.

CreatePostObject(string)
Creates a new post object.

Declaration Syntax
public IUserLoad CreatePostObject(string objName)

Parameters
objName(string)
The name of the post object. This name must be one of the name of object created in the xml extension
file.

CreateResultObject(string)
Creates a new result object.

Declaration Syntax
public IUserResult CreateResultObject(string objName)

Parameters
objName(string)
The name of the result object. This name must be one of the name of object created in the xml extension
file.

CurrentConsistentUnitFromQuantityName(string)
Returns the current consistent unit from a quantity name.

Declaration Syntax
public string CurrentConsistentUnitFromQuantityName(string quantityName)

364

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IAnalysis

Parameters
quantityName(string)
The quantity name.

GenerateMesh()
Generates the mesh of the analysis.

Declaration Syntax
public void GenerateMesh()

GetResultsData()
Returns the result reader associated to the analysis.

Declaration Syntax
public IResultReader GetResultsData()

PropertyValue(string)
Returns the value of the property that matches the specified name.

Declaration Syntax
public object PropertyValue(string name)

Parameters
name(string)
The name of the property.

PropertyValue(string, object)
Assigns the given value to the property that matches the specified name.

Declaration Syntax
public void PropertyValue(string name, object value)

Parameters
name(string)
The name of the property.
value(object)
The value.

Solve(bool)
Computes the analysis solution.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

365

Ansys.ACT.Interfaces.Analysis Namespace

Declaration Syntax
public void Solve(bool wait)

Parameters
wait(bool)
Specifies to wait the completion of the solution before return.

WriteInputFile(string)
Writes the input file associated to the analysis.

Declaration Syntax
public void WriteInputFile(string filename)

Parameters
filename(string)
The name of the file to generate.

ICoordinateSystem
Defines a coordinate system.

Declaration Syntax
public interface ICoordinateSystem
Table 258: Members
Property CoordinateSystemType Gets or sets the coordinate system type.
Property Id

Gets or sets the ID of the coordinate system.

Property Matrix

Gets or sets the matrix definition of the coordinate


system.

Property Name

Gets or sets the name of the coordinate system.

Property Origin

Gets or sets the origin of the coordinate system.

Property XAxis

Gets or sets the X axis of the coordinate system.

Property YAxis

Gets or sets the Y axis of the coordinate system.

Property ZAxis

Gets or sets the Z axis of the coordinate system.

CoordinateSystemType
Gets or sets the coordinate system type.

Declaration Syntax
public CoordinateSystemTypeEnum CoordinateSystemType { set;get; }

366

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ICoordinateSystem

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; }

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.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

367

Ansys.ACT.Interfaces.Analysis Namespace

Declaration Syntax
public IEnumerable<double> ZAxis { set;get; }

IDataObject
Defines an object of the application data model.

Declaration Syntax
public interface IDataObject
Table 259: Members
Property Id

Gets the ID for the object.

Property Name

Gets the name for the object.

Property PropertyNames

Gets the list of properties.

Property Type

Gets the type for the object.

Method PropertyValue(string)

Returns the value of the property that matches the specified


name.

Method PropertyValue(string, object) Assigns the given value to the property that matches the
specified name.

Id
Gets the ID for the object.

Declaration Syntax
public int Id { get; }

Name
Gets the name for the object.

Declaration Syntax
public string Name { get; }

PropertyNames
Gets the list of properties.

Declaration Syntax
public IList<string> PropertyNames { get; }

Type
Gets the type for the object.

368

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IDataObjectCollection

Declaration Syntax
public string Type { get; }

PropertyValue(string)
Returns the value of the property that matches the specified name.

Declaration Syntax
public object PropertyValue(string name)

Parameters
name(string)
The name of the property.

PropertyValue(string, object)
Assigns the given value to the property that matches the specified name.

Declaration Syntax
public void PropertyValue(string name, object value)

Parameters
name(string)
The name of the property.
value(object)
The value to assign.

IDataObjectCollection
Defines a collection of objects of the application data model.

Declaration Syntax
public interface IDataObjectCollection
Table 260: Members
Property Ids

Gets the list of objects IDs.

Property List

Gets the list of objects.

Property Names

Gets the list of objects names.

Method GetById(int)

Returns an object by its ID.

Method GetByName(string)

Returns an object by its name.

Method GetEnumerator()

Returns an enumerator for the collection.

Method NamesByType(string) Returns the list of object names filtered by


type.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

369

Ansys.ACT.Interfaces.Analysis Namespace

Ids
Gets the list of objects IDs.

Declaration Syntax
public IList<int> Ids { get; }

List
Gets the list of objects.

Declaration Syntax
public IList<IDataObject> List { get; }

Names
Gets the list of objects names.

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

GetById(int)
Returns an object by its ID.

Declaration Syntax
public IDataObject GetById(int id)

Parameters
id(int)
The ID of the object.

GetByName(string)
Returns an object by its name.

Declaration Syntax
public IDataObject GetByName(string name)

Parameters
name(string)
The name of the object.

370

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISolverData

GetEnumerator()
Returns an enumerator for the collection.

Declaration Syntax
public IEnumerator<IDataObject> GetEnumerator()

NamesByType(string)
Returns the list of object names filtered by type.

Declaration Syntax
public IList<string> NamesByType(string dataType)

Parameters
dataType(string)
The datatype filter.

IDataObjectContainer
Defines a container of objects.

Declaration Syntax
public interface IDataObjectContainer
Table 261: Members
Property DataObjects Gets the collection of
objects.

DataObjects
Gets the collection of objects.

Declaration Syntax
public IDataObjectCollection DataObjects { get; }

ISolverData
Defines the data associated to a specfied solve type.

Declaration Syntax
public interface ISolverData
Table 262: Members
Property CurrentStep

Gets the current step number.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

371

Ansys.ACT.Interfaces.Analysis Namespace
Property MaxElementId

Gets the current maximum element id of the solver.

Property MaxElementType

Gets the current maximum element type id of the solver.

Property MaxNodeId

Gets the current maximum node id of the solver.

Property SolveType

Gets the type of the current solve.

Method GetContactId(int)

Returns the solver contact identifier by its data model


id.

Method GetContactTargetId(int)

Returns the solver target contact identifier by its data


model id.

Method GetCoordinateSystemSolverId(int) Returns the solver identifier of a coordinate system by


its data model id.
Method GetMaterialSolverId(int)

Returns the solver material identifier related to a body


id.

Method GetNewElementId()

Generates a new element id, and increment the


MaxElementId property.

Method GetNewElementType()

Generates a new element type id, and increment the


MaxElementType property.

Method GetNewNodeId()

Generates a new node id, and increment the MaxNodeId


property.

Method GetRemotePointNodeId(int)

Returns the node id associated to a remote point.

CurrentStep
Gets the current step number.

Declaration Syntax
public uint CurrentStep { get; }

MaxElementId
Gets the current maximum element id of the solver.

Declaration Syntax
public ulong MaxElementId { get; }

MaxElementType
Gets the current maximum element type id of the solver.

Declaration Syntax
public uint MaxElementType { get; }

MaxNodeId
Gets the current maximum node id of the solver.

372

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ISolverData

Declaration Syntax
public ulong MaxNodeId { get; }

SolveType
Gets the type of the current solve.

Declaration Syntax
public SolveTypeEnum SolveType { get; }

GetContactId(int)
Returns the solver contact identifier by its data model id.

Declaration Syntax
public string GetContactId(int treeId)

Parameters
treeId(int)
The id of the contact object.

GetContactTargetId(int)
Returns the solver target contact identifier by its data model id.

Declaration Syntax
public string GetContactTargetId(int treeId)

Parameters
treeId(int)
The id of the contact object.

GetCoordinateSystemSolverId(int)
Returns the solver identifier of a coordinate system by its data model id.

Declaration Syntax
public string GetCoordinateSystemSolverId(int id)

Parameters
id(int)
The id of the coordinate system.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

373

Ansys.ACT.Interfaces.Analysis Namespace

GetMaterialSolverId(int)
Returns the solver material identifier related to a body id.

Declaration Syntax
public string GetMaterialSolverId(int bodyId)

Parameters
bodyId(int)
The id of the body.

GetNewElementId()
Generates a new element id, and increment the MaxElementId property.

Declaration Syntax
public ulong GetNewElementId()

GetNewElementType()
Generates a new element type id, and increment the MaxElementType property.

Declaration Syntax
public uint GetNewElementType()

GetNewNodeId()
Generates a new node id, and increment the MaxNodeId property.

Declaration Syntax
public ulong GetNewNodeId()

GetRemotePointNodeId(int)
Returns the node id associated to a remote point.

Declaration Syntax
public int GetRemotePointNodeId(int remotePointId)

Parameters
remotePointId(int)
The id of the remote point.

374

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

SolveTypeEnum

SolveTypeEnum
Specifies the type of solve.

Declaration Syntax
public enum SolveTypeEnum
Table 263: Members
Member Eigen

Eigen solve type.

Member Electric

Electric solve type.

Member EMag

EMag solve type.

Member Harmonic

Harmonic solve type.

Member Modal

Modal solve type.

Member MPRS

MPRS solve type.

Member MPRSAcceleration

MPRSAcceleration solve type.

Member MPRSVelocity

MPRSVelocity solve type.

Member MSUPChartExpansion

MSUPChartExpansion solve type.

Member MSUPExpansion

MSUPExpansion solve type.

Member MSUPHarmonic

MSUPHarmonic solve type.

Member MSUPHarmonicAccelerationX

MSUPHarmonicAccelerationX solve type.

Member MSUPHarmonicAccelerationY

MSUPHarmonicAccelerationY solve type.

Member MSUPHarmonicAccelerationZ

MSUPHarmonicAccelerationZ solve type.

Member MSUPHarmonicBearingLoad

MSUPHarmonicBearingLoad solve type.

Member MSUPHarmonicForceSurfaceX

MSUPHarmonicForceSurfaceX solve type.

Member MSUPHarmonicForceSurfaceXImaginary

MSUPHarmonicForceSurfaceXImaginary solve type.

Member MSUPHarmonicForceSurfaceY

MSUPHarmonicForceSurfaceY solve type.

Member MSUPHarmonicForceSurfaceYImaginary

MSUPHarmonicForceSurfaceYImaginary solve type.

Member MSUPHarmonicForceSurfaceZ

MSUPHarmonicForceSurfaceZ solve type.

Member MSUPHarmonicForceSurfaceZImaginary

MSUPHarmonicForceSurfaceZImaginary solve type.

Member MSUPHarmonicPreStressed

MSUPHarmonicPreStressed solve type.

Member MSUPHarmonicRemoteLoadX

MSUPHarmonicRemoteLoadX solve type.

Member MSUPHarmonicRemoteLoadXImaginary

MSUPHarmonicRemoteLoadXImaginary solve type.

Member MSUPHarmonicRemoteLoadY

MSUPHarmonicRemoteLoadY solve type.

Member MSUPHarmonicRemoteLoadYImaginary

MSUPHarmonicRemoteLoadYImaginary solve type.

Member MSUPHarmonicRemoteLoadZ

MSUPHarmonicRemoteLoadZ solve type.

Member MSUPHarmonicRemoteLoadZImaginary

MSUPHarmonicRemoteLoadZImaginary solve type.

Member MSUPHarmonicSFBasedLoad

MSUPHarmonicSFBasedLoad solve type.

Member MSUPHarmonicSFBasedLoadImaginary

MSUPHarmonicSFBasedLoadImaginary solve type.

Member MSUPHarmonicSFBasedLoadLinePressure

MSUPHarmonicSFBasedLoadLinePressure solve
type.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

375

Ansys.ACT.Interfaces.Analysis Namespace
Member MSUPHarmonicSFBasedLoadPathDependent

MSUPHarmonicSFBasedLoadPathDependent solve
type.

Member MSUPHarmonicSFBasedLoadPipePressure

MSUPHarmonicSFBasedLoadPipePressure solve
type.

Member MSUPHarmonicSFBasedLoadPipePressurePathDependent MSUPHarmonicSFBasedLoadPipePressurePathDepen


solve type.
Member MSUPHarmonicSFBasedLoadReal

MSUPHarmonicSFBasedLoadReal solve type.

Member MSUPHarmonicVertexFollowElement

MSUPHarmonicVertexFollowElement solve type.

Member MSUPHarmonicVertexFollowElementImaginary

MSUPHarmonicVertexFollowElementImaginary solve
type.

Member MSUPTransient

MSUPTransient solve type.

Member Spectral

Spectral solve type.

Member SPRS

SPRS solve type.

Member SPRSAcceleration

SPRSAcceleration solve type.

Member SPRSVelocity

SPRSVelocity solve type.

Member Structural

Structural solve type.

Member Thermal

Thermal solve type.

Member ThermoElectric

ThermoElectric solve type.

Member Unknown

Unknown solve type. This is the default solver type.

376

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Math Namespace
Declaration Syntax
namespace Ansys.ACT.Math
Table 264: Members
Matrix4D Transformation matrix *single linear* *standard zero-based row-column index* | 0 4 8 12
| | Rot00*Sx Rot01 Rot02 TransX | | 1 5 9 13 | | Rot10 Rot11*Sy Rot12 TransY | | 2 6 10 14
| = | Rot20 Rot21 Rot22*Sz TransZ | | 3 7 11 15 | | 0 (30) 0 (31) 0 (32) 1 (33) |
Vector3D Vector in 3D-space

Matrix4D
Transformation matrix *single linear* *standard zero-based row-column index* | 0 4 8 12 | | Rot00*Sx
Rot01 Rot02 TransX | | 1 5 9 13 | | Rot10 Rot11*Sy Rot12 TransY | | 2 6 10 14 | = | Rot20 Rot21 Rot22*Sz
TransZ | | 3 7 11 15 | | 0 (30) 0 (31) 0 (32) 1 (33) |

Declaration Syntax
public class Matrix4D
Table 265: Members
Constructor Matrix4D()

Default constructor - creates identity 4x4 matrix

Constructor Matrix4D(double[])

Construct 4x4 matrix initialized to given entries. If


entries not valid, an identity 4x4 matrix is
constructed.

Constructor Matrix4D(Matrix4D)

Copy constructor

Field

Identity

Identity 4x4 matrix

Property

Determinant

Matrix determinant accessor.

Property

Item

An OpenGL compatible linear indexer to the matrix


entries | 0 4 8 12 | | 1 5 9 13 | | 2 6 10 14 | | 3 7 11
15 |

Property

Item

A standard (row, column) indexer to the matrix


entries | 0,0 0,1 0,2 0,3 | | 1,0 1,1 1,2 1,3 | | 2,0 2,1
2,2 2,3 | | 3,0 3,1 3,2 3,3 |

Method

Add(Matrix4D)

Add matrix to itself.

Method

CreateMirror(Vector3D, double)

Create transformation matrix mirroring about a


plane

Method

CreateRotate(Vector3D, double)

Create transformation matrix that rotates about a


given vector by a given angle

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

377

Ansys.ACT.Math Namespace
Method

CreateScale(double, double,
double)

Create scaling transformation matrix

Method

CreateSystem(Vector3D, Vector3D,
Vector3D)

Create transformation matrix converting to new


coordinate system.

Method

CreateTranslate(double, double,
double)

Create translating transformation matrix

Method

Invert()

Invert itself if determinant is non-zero. Return 0 if


inverted; 1 - otherwise.

Method

Multiply(Matrix4D)

Multiply this matrix by the given matrix

Method

Scale(double, double, double)

Convenient method to combine x, y, z scale into


itself.

Method

Subtract(Matrix4D)

Subtract matrix from itself.

Method

ToString()

String representation.

Method

Transform(Vector3D)

Apply this transformation matrix to a given


point/vector. Note: assumes (0,0,0,1) in last row.

Method

Translate(double, double, double)

Convenient method to combine (x, y, z)


translatation into itself.

Method

Transpose()

Transpose itself.

operator

op_Addition(Matrix4D, Matrix4D)

Matrix addition operator.

operator

op_Explicit(Matrix4D)

Cast operator into OpenGL's format matrix array.

operator

op_Multiply(Matrix4D, Matrix4D)

Matrix multiplication operator - assumes (0,0,0,1)


in last row.

operator

op_Subtraction(Matrix4D, Matrix4D) Matrix subtraction operator.

Matrix4D()
Default constructor - creates identity 4x4 matrix

Declaration Syntax
public Matrix4D()

Matrix4D(double[])
Construct 4x4 matrix initialized to given entries. If entries not valid, an identity 4x4 matrix is constructed.

Declaration Syntax
public Matrix4D(double[] entries)

Parameters
entries(double[])
No details are provided for this entry.

Matrix4D(Matrix4D)
Copy constructor
378

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Matrix4D

Declaration Syntax
public Matrix4D(Matrix4D m44)

Parameters
m44(Matrix4D)
No details are provided for this entry.

Identity
Identity 4x4 matrix

Declaration Syntax
public static readonly Matrix4D Identity

Determinant
Matrix determinant accessor.

Declaration Syntax
public double Determinant { get; }

Item
An OpenGL compatible linear indexer to the matrix entries | 0 4 8 12 | | 1 5 9 13 | | 2 6 10 14 | | 3 7 11
15 |

Declaration Syntax
public double Item { set;get; }

Item
A standard (row, column) indexer to the matrix entries | 0,0 0,1 0,2 0,3 | | 1,0 1,1 1,2 1,3 | | 2,0 2,1 2,2
2,3 | | 3,0 3,1 3,2 3,3 |

Declaration Syntax
public double Item { set;get; }

Add(Matrix4D)
Add matrix to itself.

Declaration Syntax
public void Add(Matrix4D m44)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

379

Ansys.ACT.Math Namespace

Parameters
m44(Matrix4D)
No details are provided for this entry.

CreateMirror(Vector3D, double)
Create transformation matrix mirroring about a plane

Declaration Syntax
public static Matrix4D CreateMirror(Vector3D normal, double d)

Parameters
normal(Vector3D)
No details are provided for this entry.
d(double)
No details are provided for this entry.

CreateRotate(Vector3D, double)
Create transformation matrix that rotates about a given vector by a given angle

Declaration Syntax
public static Matrix4D CreateRotate(Vector3D rotationAxis, double rotationRadians)

Parameters
rotationAxis(Vector3D)
No details are provided for this entry.
rotationRadians(double)
No details are provided for this entry.

CreateScale(double, double, double)


Create scaling transformation matrix

Declaration Syntax
public static Matrix4D CreateScale(double x, double y, double z)

Parameters
x(double)
No details are provided for this entry.
y(double)
No details are provided for this entry.

380

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Matrix4D
z(double)
No details are provided for this entry.

CreateSystem(Vector3D, Vector3D, Vector3D)


Create transformation matrix converting to new coordinate system.

Declaration Syntax
public static Matrix4D CreateSystem(Vector3D xAxis, Vector3D yAxis, Vector3D zAxis)

Parameters
xAxis(Vector3D)
No details are provided for this entry.
yAxis(Vector3D)
No details are provided for this entry.
zAxis(Vector3D)
No details are provided for this entry.

CreateTranslate(double, double, double)


Create translating transformation matrix

Declaration Syntax
public static Matrix4D CreateTranslate(double x, double y, double z)

Parameters
x(double)
No details are provided for this entry.
y(double)
No details are provided for this entry.
z(double)
No details are provided for this entry.

Invert()
Invert itself if determinant is non-zero. Return 0 if inverted; 1 - otherwise.

Declaration Syntax
public int Invert()

Multiply(Matrix4D)
Multiply this matrix by the given matrix

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

381

Ansys.ACT.Math Namespace

Declaration Syntax
public void Multiply(Matrix4D m44)

Parameters
m44(Matrix4D)
No details are provided for this entry.

Scale(double, double, double)


Convenient method to combine x, y, z scale into itself.

Declaration Syntax
public void Scale(double x, double y, double z)

Parameters
x(double)
No details are provided for this entry.
y(double)
No details are provided for this entry.
z(double)
No details are provided for this entry.

Subtract(Matrix4D)
Subtract matrix from itself.

Declaration Syntax
public void Subtract(Matrix4D m44)

Parameters
m44(Matrix4D)
No details are provided for this entry.

ToString()
String representation.

Declaration Syntax
public override string ToString()

Transform(Vector3D)
Apply this transformation matrix to a given point/vector. Note: assumes (0,0,0,1) in last row.

382

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Matrix4D

Declaration Syntax
public Vector3D Transform(Vector3D vector3D)

Parameters
vector3D(Vector3D)
No details are provided for this entry.

Translate(double, double, double)


Convenient method to combine (x, y, z) translatation into itself.

Declaration Syntax
public void Translate(double x, double y, double z)

Parameters
x(double)
No details are provided for this entry.
y(double)
No details are provided for this entry.
z(double)
No details are provided for this entry.

Transpose()
Transpose itself.

Declaration Syntax
public void Transpose()

op_Addition(Matrix4D, Matrix4D)
Matrix addition operator.

Declaration Syntax
public static Matrix4D operator +(Matrix4D a, Matrix4D b)

Parameters
a(Matrix4D)
No details are provided for this entry.
b(Matrix4D)
No details are provided for this entry.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

383

Ansys.ACT.Math Namespace

op_Explicit(Matrix4D)
Cast operator into OpenGL's format matrix array.

Declaration Syntax
public static double[] operator op_Explicit(Matrix4D m44)

Parameters
m44(Matrix4D)
No details are provided for this entry.

op_Multiply(Matrix4D, Matrix4D)
Matrix multiplication operator - assumes (0,0,0,1) in last row.

Declaration Syntax
public static Matrix4D operator *(Matrix4D a, Matrix4D b)

Parameters
a(Matrix4D)
No details are provided for this entry.
b(Matrix4D)
No details are provided for this entry.

op_Subtraction(Matrix4D, Matrix4D)
Matrix subtraction operator.

Declaration Syntax
public static Matrix4D operator -(Matrix4D a, Matrix4D b)

Parameters
a(Matrix4D)
No details are provided for this entry.
b(Matrix4D)
No details are provided for this entry.

Vector3D
Vector in 3D-space

384

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Vector3D

Declaration Syntax
public sealed struct Vector3D : ValueType, ICloneable
Table 266: Members
Constructor Vector3D(double[])

Create a vector with coordinates set to


"coordinates". Depending on the length of
"coordinates" array, assign 0, 1, 2, or 3 of
vector's components.

Constructor Vector3D(Vector3D)

Copy constructor

Constructor Vector3D(double, double, double)

Create a vector with ( x, y, z ) coordinates

Field

X-axis

Field

IJK

XYZ

Field

Y-axis

Field

Z-axis

Field

The X coordinate

Field

The Y coordinate

Field

The Z coordinate

Field

Zero

Coordinate system origin

Property

Item

Indexer

Property

Magnitude

Vector magnitude accessor

Property

MagnitudeSquared

Vector magnitude squared accessor

Method

Add(Vector3D)

Add vector to itself.

Method

CloneNormalized()

Create a normalized copy of a vector

Method

Cross(Vector3D, Vector3D)

Cross product - same as multiply operator

Method

CrossProduct(Vector3D)

Cross product.

Method

Dot(Vector3D, Vector3D)

Dot product.

Method

DotProduct(Vector3D)

Dot product.

Method

Equals(object)

Object.Equals(object o) override

Method

GetDistance(Vector3D, Vector3D)

Squared distance between vectors/points

Method

GetDistanceSquared(Vector3D, Vector3D) Squared distance between vectors/points

Method

GetHashCode()

Object.GetHashCode() override

Method

Normalize()

Convert to an unit vector

Method

Subtract(Vector3D)

Subtract vector from itself.

Method

ToString()

String representation.

operator

op_Addition(Vector3D, Vector3D)

Plus operator

operator

op_Division(Vector3D, double)

Divide a vector by a factor operator.

operator

op_Equality(Vector3D, Vector3D)

Equal operator

operator

op_Explicit(Vector3D)

Cast operator into a double[] array.

operator

op_Inequality(Vector3D, Vector3D)

Not-Equal operator

operator

op_Multiply(double, Vector3D)

Multiply a factor by a vector operator.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

385

Ansys.ACT.Math Namespace
operator

op_Multiply(Vector3D, double)

Multiply a vector by a factor operator.

operator

op_Multiply(Vector3D, Vector3D)

Multiply two vectors operator - defined as


CrossProduct.

operator

op_Subtraction(Vector3D, Vector3D)

Minus operator

operator

op_UnaryNegation(Vector3D)

Unary minus operator

Vector3D(double[])
Create a vector with coordinates set to "coordinates". Depending on the length of "coordinates" array,
assign 0, 1, 2, or 3 of vector's components.

Declaration Syntax
public Vector3D(double[] coordinates)

Parameters
coordinates(double[])
No details are provided for this entry.

Vector3D(Vector3D)
Copy constructor

Declaration Syntax
public Vector3D(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

Vector3D(double, double, double)


Create a vector with ( x, y, z ) coordinates

Declaration Syntax
public Vector3D(double x, double y, double z)

Parameters
x(double)
No details are provided for this entry.
y(double)
No details are provided for this entry.
z(double)
No details are provided for this entry.

386

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Vector3D

I
X-axis

Declaration Syntax
public static readonly Vector3D I

IJK
XYZ

Declaration Syntax
public static readonly Vector3D IJK

J
Y-axis

Declaration Syntax
public static readonly Vector3D J

K
Z-axis

Declaration Syntax
public static readonly Vector3D K

X
The X coordinate

Declaration Syntax
public double X

Y
The Y coordinate

Declaration Syntax
public double Y

Z
The Z coordinate

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

387

Ansys.ACT.Math Namespace

Declaration Syntax
public double Z

Zero
Coordinate system origin

Declaration Syntax
public static readonly Vector3D Zero

Item
Indexer

Declaration Syntax
public double Item { set;get; }

Magnitude
Vector magnitude accessor

Declaration Syntax
public double Magnitude { get; }

MagnitudeSquared
Vector magnitude squared accessor

Declaration Syntax
public double MagnitudeSquared { get; }

Add(Vector3D)
Add vector to itself.

Declaration Syntax
public void Add(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

CloneNormalized()
Create a normalized copy of a vector

388

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Vector3D

Declaration Syntax
public Vector3D CloneNormalized()

Cross(Vector3D, Vector3D)
Cross product - same as multiply operator

Declaration Syntax
public static Vector3D Cross(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

CrossProduct(Vector3D)
Cross product.

Declaration Syntax
public Vector3D CrossProduct(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

Dot(Vector3D, Vector3D)
Dot product.

Declaration Syntax
public static double Dot(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

DotProduct(Vector3D)
Dot product.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

389

Ansys.ACT.Math Namespace

Declaration Syntax
public double DotProduct(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

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

Declaration Syntax
public override bool Equals(object o)

Parameters
o(object)
No details are provided for this entry.

GetDistance(Vector3D, Vector3D)
Squared distance between vectors/points

Declaration Syntax
public static double GetDistance(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

GetDistanceSquared(Vector3D, Vector3D)
Squared distance between vectors/points

Declaration Syntax
public static double GetDistanceSquared(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

390

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Vector3D

GetHashCode()
Object.GetHashCode() override

Declaration Syntax
public override int GetHashCode()

Normalize()
Convert to an unit vector

Declaration Syntax
public void Normalize()

Subtract(Vector3D)
Subtract vector from itself.

Declaration Syntax
public void Subtract(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

ToString()
String representation.

Declaration Syntax
public override string ToString()

op_Addition(Vector3D, Vector3D)
Plus operator

Declaration Syntax
public static Vector3D operator +(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

391

Ansys.ACT.Math Namespace

op_Division(Vector3D, double)
Divide a vector by a factor operator.

Declaration Syntax
public static Vector3D operator /(Vector3D vec3, double divFactor)

Parameters
vec3(Vector3D)
No details are provided for this entry.
divFactor(double)
No details are provided for this entry.

op_Equality(Vector3D, Vector3D)
Equal operator

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

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

op_Explicit(Vector3D)
Cast operator into a double[] array.

Declaration Syntax
public static double[] operator op_Explicit(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

op_Inequality(Vector3D, Vector3D)
Not-Equal operator

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

392

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Vector3D

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

op_Multiply(double, Vector3D)
Multiply a factor by a vector operator.

Declaration Syntax
public static Vector3D operator *(double factor, Vector3D vec3)

Parameters
factor(double)
No details are provided for this entry.
vec3(Vector3D)
No details are provided for this entry.

op_Multiply(Vector3D, double)
Multiply a vector by a factor operator.

Declaration Syntax
public static Vector3D operator *(Vector3D vec3, double factor)

Parameters
vec3(Vector3D)
No details are provided for this entry.
factor(double)
No details are provided for this entry.

op_Multiply(Vector3D, Vector3D)
Multiply two vectors operator - defined as CrossProduct.

Declaration Syntax
public static Vector3D operator *(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

393

Ansys.ACT.Math Namespace
b(Vector3D)
No details are provided for this entry.

op_Subtraction(Vector3D, Vector3D)
Minus operator

Declaration Syntax
public static Vector3D operator -(Vector3D a, Vector3D b)

Parameters
a(Vector3D)
No details are provided for this entry.
b(Vector3D)
No details are provided for this entry.

op_UnaryNegation(Vector3D)
Unary minus operator

Declaration Syntax
public static Vector3D operator -(Vector3D vec3)

Parameters
vec3(Vector3D)
No details are provided for this entry.

394

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.ACT.Interfaces.Mesh Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Mesh
Table 267: Members
ElementTypeEnum Specifies the element type.
IElement

Defines a mesh element.

IMeshData

Defines a mesh data model.

IMeshRegion

Defines a mesh region associated to a geometry


entity.

INode

Defines a mesh node.

ElementTypeEnum
Specifies the element type.

Declaration Syntax
public enum ElementTypeEnum
Table 268: Members
Member kBeam3

Three Node Beam.

Member kBeam4

Four Node Beam.

Member kHex20

Twenty Node
Hexahedron.

Member kHex8

Eight Node
Hexahedron.

Member kLine2

Two Node Line.

Member kLine3

Three Node Line.

Member kPoint0

Point.

Member kPyramid13 Thirteen Node


Pyramid.
Member kPyramid5 Five Node Pyramid.
Member kQuad4

Four Node
Quadrilateral.

Member kQuad8

Eight Node
Quadrilateral.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

395

Ansys.ACT.Interfaces.Mesh Namespace
Member kTet10

Ten Node
Tetrahedron.

Member kTet4

Four Node
Tetrahedron.

Member kTri3

Three Node Triangle.

Member kTri6

Six Node Triangle.

Member kUnknown Unknown.


Member kWedge15 Fifteen Node Wedge.
Member kWedge6

Six Node Wedge.

IElement
Defines a mesh element.

Declaration Syntax
public interface IElement
Table 269: Members
Property Area

Gets the area of the element.

Property Centroid

Gets the centroid of the element.

Property CornerNodeCount Gets the number of corner nodes.


Property CornerNodeIds

Gets the list of corner node IDs associated to the


element.

Property CornerNodes

Gets the list of corner nodes associated to the


element.

Property Dimension

Gets the dimension of the element.

Property Id

Gets the id of the element.

Property NodeIds

Gets the list of node IDs associated to the element.

Property Nodes

Gets a list of nodes associated to the element.

Property Type

Gets the element type.

Property Volume

Gets the volume of the element.

Area
Gets the area of the element.

Declaration Syntax
public double Area { get; }

Centroid
Gets the centroid of the element.

396

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IElement

Declaration Syntax
public double[] Centroid { get; }

CornerNodeCount
Gets the number of corner nodes.

Declaration Syntax
public int CornerNodeCount { get; }

CornerNodeIds
Gets the list of corner node IDs associated to the element.

Declaration Syntax
public IList<int> CornerNodeIds { get; }

CornerNodes
Gets the list of corner nodes associated to the element.

Declaration Syntax
public IList<INode> CornerNodes { get; }

Dimension
Gets the dimension of the element.

Declaration Syntax
public int Dimension { get; }

Id
Gets the id of the element.

Declaration Syntax
public int Id { get; }

NodeIds
Gets the list of node IDs associated to the element.

Declaration Syntax
public IList<int> NodeIds { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

397

Ansys.ACT.Interfaces.Mesh Namespace

Nodes
Gets a list of nodes associated to the element.

Declaration Syntax
public IList<INode> Nodes { get; }

Type
Gets the element type.

Declaration Syntax
public ElementTypeEnum Type { get; }

Volume
Gets the volume of the element.

Declaration Syntax
public double Volume { get; }

IMeshData
Defines a mesh data model.

Declaration Syntax
public interface IMeshData
Table 270: Members
Property ElementCount

Gets the number of elements of the mesh.

Property ElementIds

Gets the list of all element ids of the mesh.

Property Elements

Gets the list of all elements of the mesh.

Property NodeCount

Gets the number of nodes of the mesh.

Property NodeIds

Gets the list of all node IDs of the mesh.

Property Nodes

Gets the list of all nodes of the mesh.

Property Unit

Returns the length unit of the mesh.

Property UseCache

Gets or sets the UseCache flag.

Method ElementById(int)

Returns the element referenced by its id.

Method ElementIdsFromNodeIds(IEnumerable<int>) Returns the list of element ids associated to


the given list of node ids.
Method MeshRegionById(int)

Gets the mesh region associated to the


specified geometry entity reference identifier.

Method NodeById(int)

Returns the node referenced by its id.

398

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IMeshData
Method NodeIdsFromElementIds(IEnumerable<int>) Returns the list of node ids associated to the
given list of element ids.

ElementCount
Gets the number of elements of the mesh.

Declaration Syntax
public int ElementCount { get; }

ElementIds
Gets the list of all element ids of the mesh.

Declaration Syntax
public IList<int> ElementIds { get; }

Elements
Gets the list of all elements of the mesh.

Declaration Syntax
public IList<IElement> Elements { get; }

NodeCount
Gets the number of nodes of the mesh.

Declaration Syntax
public int NodeCount { get; }

NodeIds
Gets the list of all node IDs of the mesh.

Declaration Syntax
public IList<int> NodeIds { get; }

Nodes
Gets the list of all nodes of the mesh.

Declaration Syntax
public IList<INode> Nodes { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

399

Ansys.ACT.Interfaces.Mesh Namespace

Unit
Returns the length unit of the mesh.

Declaration Syntax
public string Unit { get; }

UseCache
Gets or sets the UseCache flag.

Declaration Syntax
public bool UseCache { set;get; }

ElementById(int)
Returns the element referenced by its id.

Declaration Syntax
public IElement ElementById(int elementId)

Parameters
elementId(int)
An element ID.

ElementIdsFromNodeIds(IEnumerable<int>)
Returns the list of element ids associated to the given list of node ids.

Declaration Syntax
public IList<int> ElementIdsFromNodeIds(IEnumerable<int> nodes)

Parameters
nodes(IEnumerable<int>)
A list of node ids.

MeshRegionById(int)
Gets the mesh region associated to the specified geometry entity reference identifier.

Declaration Syntax
public IMeshRegion MeshRegionById(int refId)

400

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IMeshRegion

Parameters
refId(int)
The reference identifier.

NodeById(int)
Returns the node referenced by its id.

Declaration Syntax
public INode NodeById(int nodeId)

Parameters
nodeId(int)
A node ID.

NodeIdsFromElementIds(IEnumerable<int>)
Returns the list of node ids associated to the given list of element ids.

Declaration Syntax
public IList<int> NodeIdsFromElementIds(IEnumerable<int> elements)

Parameters
elements(IEnumerable<int>)
A list of element ids.

IMeshRegion
Defines a mesh region associated to a geometry entity.

Declaration Syntax
public interface IMeshRegion
Table 271: Members
Property ElementCount Gets the number of elements of the
region.
Property ElementIds

Gets the list of the element ids of the


region.

Property Elements

Gets the list of the elements of the


region.

Property NodeCount

Gets the number of nodes of the region.

Property NodeIds

Gets the list of the node ids of the


region.

Property Nodes

Gets the list of the nodes of the region.


Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

401

Ansys.ACT.Interfaces.Mesh Namespace

ElementCount
Gets the number of elements of the region.

Declaration Syntax
public int ElementCount { get; }

ElementIds
Gets the list of the element ids of the region.

Declaration Syntax
public IList<int> ElementIds { get; }

Elements
Gets the list of the elements of the region.

Declaration Syntax
public IList<IElement> Elements { get; }

NodeCount
Gets the number of nodes of the region.

Declaration Syntax
public int NodeCount { get; }

NodeIds
Gets the list of the node ids of the region.

Declaration Syntax
public IList<int> NodeIds { get; }

Nodes
Gets the list of the nodes of the region.

Declaration Syntax
public IList<INode> Nodes { get; }

INode
Defines a mesh node.

402

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

INode

Declaration Syntax
public interface INode
Table 272: Members
Property BodyIds

Gets the list of body ids connected to the node.

Property ConnectedElementIds Gets the list of the element ids connected to the node.
Property ConnectedElements

Gets the list of the elements connected to the node.

Property GeoEntityIds

Gets the list of geometry entity ids associated to the


node.

Property Id

Gets the id of the node.

Property X

Gets the X coordinate of the node.

Property Y

Gets the Y coordinate of the node.

Property Z

Gets the Z coordinate of the node.

BodyIds
Gets the list of body ids connected to the node.

Declaration Syntax
public IList<int> BodyIds { get; }

ConnectedElementIds
Gets the list of the element ids connected to the node.

Declaration Syntax
public IList<int> ConnectedElementIds { get; }

ConnectedElements
Gets the list of the elements connected to the node.

Declaration Syntax
public IList<IElement> ConnectedElements { get; }

GeoEntityIds
Gets the list of geometry entity ids associated to the node.

Declaration Syntax
public IList<int> GeoEntityIds { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

403

Ansys.ACT.Interfaces.Mesh Namespace

Id
Gets the id of the node.

Declaration Syntax
public int Id { get; }

X
Gets the X coordinate of the node.

Declaration Syntax
public double X { get; }

Y
Gets the Y coordinate of the node.

Declaration Syntax
public double Y { get; }

Z
Gets the Z coordinate of the node.

Declaration Syntax
public double Z { get; }

404

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.DesignXplorer.API.Common Namespace
Declaration Syntax
namespace Ansys.DesignXplorer.API.Common
Table 273: Members
enumDistributionType

Enumeration of the possible parameter distribution types.

enumParameterRelationshipType

Enumeration of the possible parameter relationship types.

enumPointState

Enumeration of the possible states for a point.

enumSimulationType

Enumeration of the simulation types of a parameter.

IMethod

IMethod is the interface to be implemented by the external


method. It is the main interface of the API, used to define the
problem, run the algorithm, and retrieve the results.

IPoint

IPoint is the interface describing a point in the parametric space.


The point is defined by its input parameter values, and provides
output parameter values when up-to-date.

IServices

IServices is the interface implemented by a DX object and made


available to the IMethod to let it access services to calculate
points, publish progress, etc.

IUserExtensionOptimizationCriterion No details are provided for this entry.


IUserExtensionParameter

No details are provided for this entry.

enumDistributionType
Enumeration of the possible parameter distribution types.

Declaration Syntax
public enum enumDistributionType

enumParameterRelationshipType
Enumeration of the possible parameter relationship types.

Declaration Syntax
public enum enumParameterRelationshipType

enumPointState
Enumeration of the possible states for a point.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

405

Ansys.DesignXplorer.API.Common Namespace

Declaration Syntax
public enum enumPointState

enumSimulationType
Enumeration of the simulation types of a parameter.

Declaration Syntax
public enum enumSimulationType

IMethod
IMethod is the interface to be implemented by the external method. It is the main interface of the API,
used to define the problem, run the algorithm, and retrieve the results.

Declaration Syntax
public interface IMethod
Table 274: Members
Method AddDoubleListVariable(string, IListCpp,
double)

Adds an input double-precision variable with its


sorted list of possible double-precision values.

Method AddDoubleVariable(string, double,


double, double)

Adds an input continuous double-precision


variable with its range of variation.

Method AddIntegerListVariable(string, IListCpp,


int)

Adds an input integer variable with its list of


possible integer values.

Method AddOutput(string)

Adds an output double-precision variable.

Method AddParameterRelationship(string, string,


string, enumParameterRelationshipType)

Adds a Parameter Relationship.

Method CanRun(out String)

Checks the ability of the method to run.

Method get_Setting(string)

Returns the value of an algorithm setting


identified by its name.

Method put_Setting(string, object)

Sets the value of an algorithm setting identified


by its name.

Method Run()

Runs the method.

AddDoubleListVariable(string, IListCpp, double)


Adds an input double-precision variable with its sorted list of possible double-precision values.

Declaration Syntax
public void AddDoubleListVariable(string bsVariableID, IListCpp pValues, double dblInitialValue)

406

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IMethod

Parameters
bsVariableID(string)
Variable identifier.
pValues(IListCpp)
Sorted list of possible double-precision values.
dblInitialValue(double)
Initial value of the variable. For an optimization method, this is the value at the starting point, if the
method uses one.

AddDoubleVariable(string, double, double, double)


Adds an input continuous double-precision variable with its range of variation.

Declaration Syntax
public void AddDoubleVariable(string bsVariableID, double dblLowerBound, double dblUpperBound,
double dblInitialValue)

Parameters
bsVariableID(string)
Variable identifier.
dblLowerBound(double)
Lower bound.
dblUpperBound(double)
Upper bound.
dblInitialValue(double)
Initial value of the variable. For an optimization method, this is the value at the starting point, if the
method uses one.

AddIntegerListVariable(string, IListCpp, int)


Adds an input integer variable with its list of possible integer values.

Declaration Syntax
public void AddIntegerListVariable(string bsVariableID, IListCpp pValues, int iInitialValue)

Parameters
bsVariableID(string)
Variable identifier.
pValues(IListCpp)
List of possible integer values.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

407

Ansys.DesignXplorer.API.Common Namespace
iInitialValue(int)
Initial value of the variable. For an optimization method, this is the value at the starting point, if the
method uses one.

AddOutput(string)
Adds an output double-precision variable.

Declaration Syntax
public void AddOutput(string bsVariableID)

Parameters
bsVariableID(string)
Variable identifier.

AddParameterRelationship(string, string, string, enumParameterRelationshipType)


Adds a Parameter Relationship.

Declaration Syntax
public void AddParameterRelationship(string bsVariableID, string bsLeftExpression, string bsRightExpression, enumParameterRelationshipType eParameterRelationshipType)

Parameters
bsVariableID(string)
Variable identifier.
bsLeftExpression(string)
Left Expression.
bsRightExpression(string)
Right Expression.
eParameterRelationshipType(enumParameterRelationshipType)
Parameter Relationship type.

CanRun(out String)
Checks the ability of the method to run.

Declaration Syntax
public bool CanRun(out String bsErrorMessage)

Parameters
bsErrorMessage(String)
If CanRun returns False, message detailing why.
408

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IPoint

get_Setting(string)
Returns the value of an algorithm setting identified by its name.

Declaration Syntax
public object get_Setting(string bsSetting)

Parameters
bsSetting(string)
Name of the algorithm setting.

put_Setting(string, object)
Sets the value of an algorithm setting identified by its name.

Declaration Syntax
public void put_Setting(string bsSetting, object vntVal)

Parameters
bsSetting(string)
Name of the algorithm setting.
vntVal(object)
New value of the algorithm setting.

Run()
Runs the method.

Declaration Syntax
public void Run()

IPoint
IPoint is the interface describing a point in the parametric space. The point is defined by its input
parameter values, and provides output parameter values when up-to-date.

Declaration Syntax
public interface IPoint
Table 275: Members
Property ID

Returns the identifier of the point.

Property State

Returns the point state.

Property StateMessage

Returns the message detailing the current point


state.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

409

Ansys.DesignXplorer.API.Common Namespace
Method get_Value(string)

Returns the variable value.

Method put_Value(string, object)

Sets the variable value.

ID
Returns the identifier of the point.

Declaration Syntax
public string ID { set;get; }

State
Returns the point state.

Declaration Syntax
public enumPointState State { set;get; }

StateMessage
Returns the message detailing the current point state.

Declaration Syntax
public string StateMessage { set;get; }

get_Value(string)
Returns the variable value.

Declaration Syntax
public object get_Value(string bsVariableID)

Parameters
bsVariableID(string)
Variable identifier.

put_Value(string, object)
Sets the variable value.

Declaration Syntax
public void put_Value(string bsVariableID, object vntNewVal)

Parameters
bsVariableID(string)
Variable identifier.

410

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IServices
vntNewVal(object)
Variable value.

IServices
IServices is the interface implemented by a DX object and made available to the IMethod to let it access
services to calculate points, publish progress, etc.

Declaration Syntax
public interface IServices
Table 276: Members
Property ExistingPoints

Returns the list of up-to-date points


available to the method before the
beginning of the process.

Property Stopped

Returns True if the user has


requested to stop the process, False
otherwise.

Method CalculateParameterRelationshipsFromPoint(IPoint)

Calculates the parameter relationship


values for a point. The point must
provide a value for each input
parameter. The parameter
relationship values are set on
successful calculation, which is
indicated by the state of the point.

Method CalculateParameterRelationshipsFromPoints(IListCpp) Calculates the parameter relationship


values for a list of points. The points
must provide a value for each of
input parameter. The parameter
relationship values are set on
successful calculation, which is
indicated by the state of the points.
Method CalculatePoint(IPoint)

Calculates the output parameter


values for a point. The point must
provide a value for each input
parameter. The output parameter
values are set on successful
calculation, which is indicated by the
state of the point.

Method CalculatePoints(IListCpp)

Calculates the output parameter


values for a list of points. The points
must provide a value for each of
input parameter. The output
parameter values are set on
successful calculation, which is
indicated by the state of the points.

Method PublishLogMessage(string)

Publishes a message to the log file


produced for each method run.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

411

Ansys.DesignXplorer.API.Common Namespace
Method PublishProgress(string, int)

Publishes progress details to


contribute to the user feedback.

ExistingPoints
Returns the list of up-to-date points available to the method before the beginning of the process.

Declaration Syntax
public IListCpp ExistingPoints { get; }

Stopped
Returns True if the user has requested to stop the process, False otherwise.

Declaration Syntax
public bool Stopped { get; }

CalculateParameterRelationshipsFromPoint(IPoint)
Calculates the parameter relationship values for a point. The point must provide a value for each input
parameter. The parameter relationship values are set on successful calculation, which is indicated by
the state of the point.

Declaration Syntax
public void CalculateParameterRelationshipsFromPoint(IPoint pPoint)

Parameters
pPoint(IPoint)
Point to process.

CalculateParameterRelationshipsFromPoints(IListCpp)
Calculates the parameter relationship values for a list of points. The points must provide a value for
each of input parameter. The parameter relationship values are set on successful calculation, which is
indicated by the state of the points.

Declaration Syntax
public void CalculateParameterRelationshipsFromPoints(IListCpp pPoints)

Parameters
pPoints(IListCpp)
List of points to process.

412

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IServices

CalculatePoint(IPoint)
Calculates the output parameter values for a point. The point must provide a value for each input
parameter. The output parameter values are set on successful calculation, which is indicated by the
state of the point.

Declaration Syntax
public void CalculatePoint(IPoint pPoint)

Parameters
pPoint(IPoint)
Point to calculate.

CalculatePoints(IListCpp)
Calculates the output parameter values for a list of points. The points must provide a value for each of
input parameter. The output parameter values are set on successful calculation, which is indicated by
the state of the points.

Declaration Syntax
public void CalculatePoints(IListCpp pPoints)

Parameters
pPoints(IListCpp)
List of points to calculate.

PublishLogMessage(string)
Publishes a message to the log file produced for each method run.

Declaration Syntax
public void PublishLogMessage(string bsMessage)

Parameters
bsMessage(string)
The message to be published.

PublishProgress(string, int)
Publishes progress details to contribute to the user feedback.

Declaration Syntax
public void PublishProgress(string bsMessage, int iIncrementWorkUnits)

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

413

Ansys.DesignXplorer.API.Common Namespace

Parameters
bsMessage(string)
Short description of the current step.
iIncrementWorkUnits(int)
Positive increment to the number of achieved work units. The total number of work units for the complete
method run is 100. For instance, if 10 work units were already achieved and iIncrementWorkUnits=15, the
user interface will report a progress of 25%.

IUserExtensionOptimizationCriterion
No details are provided for this entry.

Declaration Syntax
public interface IUserExtensionOptimizationCriterion

IUserExtensionParameter
No details are provided for this entry.

Declaration Syntax
public interface IUserExtensionParameter

414

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.DesignXplorer.API.Sampling Namespace
Declaration Syntax
namespace Ansys.DesignXplorer.API.Sampling
Table 277: Members
IUserSampling IUserSampling defines a collection of properties reflecting both the attributes of the
sampling, as defined in the extension's xml file, and the current values for the
corresponding properties. For instance, it provides the value of the capability
MaximumNumberOfInputParameters which can be checked against the actual number
of defined input parameters in the Design of Experiments (property
NumberOfInputParametersDefined). An object implementing IUserSampling is passed
to each callback declared in the extension.

IUserSampling
IUserSampling defines a collection of properties reflecting both the attributes of the sampling, as defined
in the extension's xml file, and the current values for the corresponding properties. For instance, it
provides the value of the capability MaximumNumberOfInputParameters which can be checked against
the actual number of defined input parameters in the Design of Experiments (property NumberOfInputParametersDefined). An object implementing IUserSampling is passed to each callback declared in the
extension.

Declaration Syntax
public interface IUserSampling
Table 278: Members
Property LogFile

Value of the LogFile attribute of the sampling.


Indicates if the sampling provides messages to
generate a log file.

Property MaximumNumberOfDoubleListParameters Value of the


MaximumNumberOfDoubleListParameters
attribute of the sampling. Indicates the
maximum number of double list parameters
supported.
Property MaximumNumberOfDoubleParameters

Value of the
MaximumNumberOfDoubleParameters attribute
of the sampling. Indicates the maximum number
of double parameters supported.

Property MaximumNumberOfInputParameters

Value of the MaximumNumberOfInputParameters


attribute of the sampling. Indicates the

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

415

Ansys.DesignXplorer.API.Sampling Namespace
maximum number of input parameters
supported.
Property MaximumNumberOfIntegerListParameters Value of the
MaximumNumberOfIntegerListParameters
attribute of the sampling. Indicates the
maximum number of integer list parameters
supported.
Property NumberOfDoubleListParametersDefined

Actual number of double list parameters defined


in the design of experiments.

Property NumberOfDoubleParametersDefined

Actual number of double parameters defined in


the design of experiments.

Property NumberOfInputParametersDefined

Actual number of input parameters defined in


the design of experiments.

Property NumberOfIntegerListParametersDefined

Actual number of integer list parameters defined


in the design of experiments.

LogFile
Value of the LogFile attribute of the sampling. Indicates if the sampling provides messages to generate
a log file.

Declaration Syntax
public bool LogFile { set;get; }

MaximumNumberOfDoubleListParameters
Value of the MaximumNumberOfDoubleListParameters attribute of the sampling. Indicates the maximum
number of double list parameters supported.

Declaration Syntax
public int MaximumNumberOfDoubleListParameters { set;get; }

MaximumNumberOfDoubleParameters
Value of the MaximumNumberOfDoubleParameters attribute of the sampling. Indicates the maximum
number of double parameters supported.

Declaration Syntax
public int MaximumNumberOfDoubleParameters { set;get; }

MaximumNumberOfInputParameters
Value of the MaximumNumberOfInputParameters attribute of the sampling. Indicates the maximum
number of input parameters supported.

Declaration Syntax
public int MaximumNumberOfInputParameters { set;get; }
416

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserSampling

MaximumNumberOfIntegerListParameters
Value of the MaximumNumberOfIntegerListParameters attribute of the sampling. Indicates the maximum
number of integer list parameters supported.

Declaration Syntax
public int MaximumNumberOfIntegerListParameters { set;get; }

NumberOfDoubleListParametersDefined
Actual number of double list parameters defined in the design of experiments.

Declaration Syntax
public int NumberOfDoubleListParametersDefined { get; }

NumberOfDoubleParametersDefined
Actual number of double parameters defined in the design of experiments.

Declaration Syntax
public int NumberOfDoubleParametersDefined { get; }

NumberOfInputParametersDefined
Actual number of input parameters defined in the design of experiments.

Declaration Syntax
public int NumberOfInputParametersDefined { get; }

NumberOfIntegerListParametersDefined
Actual number of integer list parameters defined in the design of experiments.

Declaration Syntax
public int NumberOfIntegerListParametersDefined { get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

417

418

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.DesignXplorer.API.Optimization Namespace
Declaration Syntax
namespace Ansys.DesignXplorer.API.Optimization
Table 279: Members
DXConvergenceData

DXConvergenceData Coclass.

DXConvergenceDescription

DXConvergenceDescription Coclass.

DXOptimizationPoint

DXOptimizationPoint Coclass.

enumConstraintHandlingType Enumeration of the Constraint Handling types.


enumConstraintType

Enumeration of the possible optimization constraint types.

enumCurveType

Enumeration of the possible curve types for the convergence data.

enumGoalType

Enumeration of the possible optimization objective types.

enumPostProcessingType

Enumeration of the possible optimization result types supported by


the optimization method. Values can be combined when several types
are supported.

IConvergenceData

IConvergenceData is the interface used to describe the convergence


data exposed as one or several curves in a Convergence Criteria chart.

IConvergenceDescription

IConvergenceDescription is the interface describing the convergence


criteria provided by the optimizer.

IOptimizationMethod

IOptimizationMethod is the interface to be implemented by the


external optimizer class. It is the main interface of the API, used to
define the optimization problem, run the algorithm, and retrieve the
optimization results.

IOptimizationPoint

IOptimizationPoint is the interface describing a point in the parametric


space. The point is defined by its input parameter values, and provides
output parameter values when up-to-date.

IOptimizationServices

IOptimizationServices is the interface implemented by a DX object


and made available to the IOptimizationMethod to let it access
services to calculate points, publish progress, etc.

IUserOptimizer

IUserOptimizer defines a collection of properties reflecting both the


attributes of the optimizer, as defined in the extension's xml file, and
the current values for the corresponding properties. For instance, it
provides the value of the capability
MaximumNumberOfInputParameters which can be checked against
the actual number of defined input parameters in the optimization
study (property NumberOfInputParametersDefined). An object
implementing IUserOptimizer is passed to each callback declared in
the extension.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

419

Ansys.DesignXplorer.API.Optimization Namespace

DXConvergenceData
DXConvergenceData Coclass.

Declaration Syntax
public class DXConvergenceData : _DXConvergenceDataClass

DXConvergenceDescription
DXConvergenceDescription Coclass.

Declaration Syntax
public class DXConvergenceDescription : _DXConvergenceDescriptionClass

DXOptimizationPoint
DXOptimizationPoint Coclass.

Declaration Syntax
public class DXOptimizationPoint : _DXOptimizationPointClass

enumConstraintHandlingType
Enumeration of the Constraint Handling types.

Declaration Syntax
public enum enumConstraintHandlingType

enumConstraintType
Enumeration of the possible optimization constraint types.

Declaration Syntax
public enum enumConstraintType

enumCurveType
Enumeration of the possible curve types for the convergence data.

Declaration Syntax
public enum enumCurveType

enumGoalType
Enumeration of the possible optimization objective types.

420

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IConvergenceData

Declaration Syntax
public enum enumGoalType

enumPostProcessingType
Enumeration of the possible optimization result types supported by the optimization method. Values
can be combined when several types are supported.

Declaration Syntax
public enum enumPostProcessingType

IConvergenceData
IConvergenceData is the interface used to describe the convergence data exposed as one or several
curves in a Convergence Criteria chart.

Declaration Syntax
public interface IConvergenceData
Table 280: Members
Method get_Value(int, out Int32, out Double,
out Boolean)

Returns the convergence value for the given step


and given convergence curve.

Method put_Value(int, int, double, bool)

Sets a new convergence value for the given step


and given convergence curve.

get_Value(int, out Int32, out Double, out Boolean)


Returns the convergence value for the given step and given convergence curve.

Declaration Syntax
public void get_Value(int curveId, out Int32 newStep, out Double newVal, out Boolean isFeasible)

Parameters
curveId(int)
Index identifying the convergence curve (between 0 and number of curves-1).
newStep(Int32)
Index identifying the step.
newVal(Double)
Convergence value.
isFeasible(Boolean)
True if the corresponding point is feasible, False otherwise.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

421

Ansys.DesignXplorer.API.Optimization Namespace

put_Value(int, int, double, bool)


Sets a new convergence value for the given step and given convergence curve.

Declaration Syntax
public void put_Value(int curveId, int newStep, double newVal, bool isFeasible)

Parameters
curveId(int)
Index identifying the convergence curve (between 0 and number of curves-1).
newStep(int)
Index identifying the step. Used as the x-axis value of the convergence curve.
newVal(double)
Convergence value. Used as the y-axis value of the convergence curve.
isFeasible(bool)
True if the corresponding point is feasible, False otherwise.

IConvergenceDescription
IConvergenceDescription is the interface describing the convergence criteria provided by the optimizer.

Declaration Syntax
public interface IConvergenceDescription
Table 281: Members
Property IndexOfCurvesSupportingFeasibility

Returns the indices of the curves supporting


feasibility.

Property NumberOfFeasibleCurves

Returns the number of curves supporting


feasibility.

Property NumberOfGroups

Returns the number of groups defined.

Property Quantity

Sets the data quantity.

Property Unit

Sets the data unit.

Property XAxisLabel

Sets the X axis label.

Property YAxisLabel

Sets the Y axis label.

Method AddCurve(int, string, enumCurveType,


bool)

Adds a curve.

Method AddGroup(string)

Adds a group of curves.

Method get_CurveLabel(int)

Returns a curve label.

Method get_CurveType(int)

Returns a curve type.

Method get_GroupLabel(int)

Returns a group label.

Method get_NumberOfCurves(int)

Returns the number of curves defined for a


given group.

422

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IConvergenceDescription

IndexOfCurvesSupportingFeasibility
Returns the indices of the curves supporting feasibility.

Declaration Syntax
public IListCpp IndexOfCurvesSupportingFeasibility { get; }

NumberOfFeasibleCurves
Returns the number of curves supporting feasibility.

Declaration Syntax
public int NumberOfFeasibleCurves { get; }

NumberOfGroups
Returns the number of groups defined.

Declaration Syntax
public int NumberOfGroups { get; }

Quantity
Sets the data quantity.

Declaration Syntax
public string Quantity { set;get; }

Unit
Sets the data unit.

Declaration Syntax
public string Unit { set;get; }

XAxisLabel
Sets the X axis label.

Declaration Syntax
public string XAxisLabel { set;get; }

YAxisLabel
Sets the Y axis label.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

423

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public string YAxisLabel { set;get; }

AddCurve(int, string, enumCurveType, bool)


Adds a curve.

Declaration Syntax
public void AddCurve(int groupId, string newVal, enumCurveType curveType, bool supportFeasibility)

Parameters
groupId(int)
Index of the curve's group (between 0 and number of groups-1).
newVal(string)
Label of the curve.
curveType(enumCurveType)
Type of the curve.
supportFeasibility(bool)
True if this curve supports the feasibility property.

AddGroup(string)
Adds a group of curves.

Declaration Syntax
public void AddGroup(string newVal)

Parameters
newVal(string)
Label of the group.

get_CurveLabel(int)
Returns a curve label.

Declaration Syntax
public string get_CurveLabel(int curveId)

Parameters
curveId(int)
Index identifying the curve (between 0 and number of curves-1).

424

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationMethod

get_CurveType(int)
Returns a curve type.

Declaration Syntax
public enumCurveType get_CurveType(int curveId)

Parameters
curveId(int)
Index identifying the curve (between 0 and number of curves-1).

get_GroupLabel(int)
Returns a group label.

Declaration Syntax
public string get_GroupLabel(int groupId)

Parameters
groupId(int)
Index identifying the group (between 0 and number of groups-1).

get_NumberOfCurves(int)
Returns the number of curves defined for a given group.

Declaration Syntax
public int get_NumberOfCurves(int groupId)

Parameters
groupId(int)
Index identifying the group (between 0 and number of groups-1).

IOptimizationMethod
IOptimizationMethod is the interface to be implemented by the external optimizer class. It is the main
interface of the API, used to define the optimization problem, run the algorithm, and retrieve the optimization results.

Declaration Syntax
public interface IOptimizationMethod
Table 282: Members
Property Candidates

List of IOptimizationPoint representing the candidate


points resulting from the optimization run.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

425

Ansys.DesignXplorer.API.Optimization Namespace
Property PostProcessingTypes

Types of the result provided by the method. The


value can be one enumPostProcessingType value, or
a combination of enumPostProcessingType values.

Property Samples

List of IOptimizationPoint representing the sample


points generated by the method.

Property Services

Set by DesignXplorer to provide access to the services


needed by the method.

Method AddConstraint(string,
enumConstraintType, object, object,
double, bool)

Adds a constraint associated with a variable.

Method AddCustomConstraintProperty(string, Sets the value of a custom constraint property


string, object)
identified by its name.
Method AddCustomObjectiveProperty(string, Sets the value of a custom objective property
string, object)
identified by its name.
Method AddCustomVariableProperty(string,
string, object)

Sets the value of a custom variable property identified


by its name.

Method AddDoubleListVariable(string,
IListCpp, double)

Adds an input double-precision variable with its


sorted list of possible double-precision values.

Method AddDoubleVariable(string, double,


double, double)

Adds an input continuous double-precision variable


with its range of variation.

Method AddIntegerListVariable(string,
IListCpp, int)

Adds an input integer variable with its list of possible


integer values.

Method AddObjective(string, enumGoalType, Adds an objective associated with a variable.


double, double)
Method AddOutput(string)

Adds an output double-precision variable.

Method AddParameterRelationship(string,
string, string,
enumParameterRelationshipType)

Adds a Parameter Relationship.

Method CanRun(out String)

Checks the ability of the method to run.

Method get_Setting(string)

Returns the value of an algorithm setting identified


by its name.

Method put_Setting(string, object)

Sets the value of an algorithm setting identified by


its name.

Method Run()

Runs the method.

Candidates
List of IOptimizationPoint representing the candidate points resulting from the optimization run.

Declaration Syntax
public IListCpp Candidates { get; }

PostProcessingTypes
Types of the result provided by the method. The value can be one enumPostProcessingType value, or
a combination of enumPostProcessingType values.

426

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationMethod

Declaration Syntax
public enumPostProcessingType PostProcessingTypes { get; }

Samples
List of IOptimizationPoint representing the sample points generated by the method.

Declaration Syntax
public IListCpp Samples { get; }

Services
Set by DesignXplorer to provide access to the services needed by the method.

Declaration Syntax
public IOptimizationServices Services { set; }

AddConstraint(string, enumConstraintType, object, object, double, bool)


Adds a constraint associated with a variable.

Declaration Syntax
public void AddConstraint(string bsVariableID, enumConstraintType type, object vntConstraintValue1,
object vntConstraintValue2, double dblImportance, bool vbStrictConstraint)

Parameters
bsVariableID(string)
Variable identifier.
type(enumConstraintType)
Constraint type.
vntConstraintValue1(object)
First constraint value, used for all constraint values but the upper bound of the eCT_InsideBounds constraint.
vntConstraintValue2(object)
Second constraint value, used for the upper bound of the eCT_InsideBounds constraint.
dblImportance(double)
Importance of the constraint with respect to other constraints.
vbStrictConstraint(bool)
True if the constraint handling is Strict (determines if a point is feasible or not), False if Relaxed.

AddCustomConstraintProperty(string, string, object)


Sets the value of a custom constraint property identified by its name.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

427

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public void AddCustomConstraintProperty(string bsVariableID, string bsPropertyKey, object vntPropertyValue)

Parameters
bsVariableID(string)
Variable identifier.
bsPropertyKey(string)
Name of the custom property.
vntPropertyValue(object)
Value of the custom property.

AddCustomObjectiveProperty(string, string, object)


Sets the value of a custom objective property identified by its name.

Declaration Syntax
public void AddCustomObjectiveProperty(string bsVariableID, string bsPropertyKey, object vntPropertyValue)

Parameters
bsVariableID(string)
Variable identifier.
bsPropertyKey(string)
Name of the custom property.
vntPropertyValue(object)
Value of the custom property.

AddCustomVariableProperty(string, string, object)


Sets the value of a custom variable property identified by its name.

Declaration Syntax
public void AddCustomVariableProperty(string bsVariableID, string bsPropertyKey, object vntPropertyValue)

Parameters
bsVariableID(string)
Variable identifier.
bsPropertyKey(string)
Name of the custom property.

428

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationMethod
vntPropertyValue(object)
Value of the custom property.

AddDoubleListVariable(string, IListCpp, double)


Adds an input double-precision variable with its sorted list of possible double-precision values.

Declaration Syntax
public void AddDoubleListVariable(string bsVariableID, IListCpp pValues, double dblInitialValue)

Parameters
bsVariableID(string)
Variable identifier.
pValues(IListCpp)
Sorted list of possible double-precision values.
dblInitialValue(double)
Initial value of the variable. For an optimization method, this is the value at the starting point, if the
method uses one.

AddDoubleVariable(string, double, double, double)


Adds an input continuous double-precision variable with its range of variation.

Declaration Syntax
public void AddDoubleVariable(string bsVariableID, double dblLowerBound, double dblUpperBound,
double dblInitialValue)

Parameters
bsVariableID(string)
Variable identifier.
dblLowerBound(double)
Lower bound.
dblUpperBound(double)
Upper bound.
dblInitialValue(double)
Initial value of the variable. For an optimization method, this is the value at the starting point, if the
method uses one.

AddIntegerListVariable(string, IListCpp, int)


Adds an input integer variable with its list of possible integer values.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

429

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public void AddIntegerListVariable(string bsVariableID, IListCpp pValues, int iInitialValue)

Parameters
bsVariableID(string)
Variable identifier.
pValues(IListCpp)
List of possible integer values.
iInitialValue(int)
Initial value of the variable. For an optimization method, this is the value at the starting point, if the
method uses one.

AddObjective(string, enumGoalType, double, double)


Adds an objective associated with a variable.

Declaration Syntax
public void AddObjective(string bsVariableID, enumGoalType type, double dblTargetValue, double
dblImportance)

Parameters
bsVariableID(string)
Variable identifier.
type(enumGoalType)
Objective type.
dblTargetValue(double)
Target value if the objective type is eGT_SeekTarget.
dblImportance(double)
Importance of the objective with respect to other objectives.

AddOutput(string)
Adds an output double-precision variable.

Declaration Syntax
public void AddOutput(string bsVariableID)

Parameters
bsVariableID(string)
Variable identifier.

430

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationMethod

AddParameterRelationship(string, string, string, enumParameterRelationshipType)


Adds a Parameter Relationship.

Declaration Syntax
public void AddParameterRelationship(string bsVariableID, string bsLeftExpression, string bsRightExpression, enumParameterRelationshipType eParameterRelationshipType)

Parameters
bsVariableID(string)
Variable identifier.
bsLeftExpression(string)
Left Expression.
bsRightExpression(string)
Right Expression.
eParameterRelationshipType(enumParameterRelationshipType)
Parameter Relationship type.

CanRun(out String)
Checks the ability of the method to run.

Declaration Syntax
public bool CanRun(out String bsErrorMessage)

Parameters
bsErrorMessage(String)
If CanRun returns False, message detailing why.

get_Setting(string)
Returns the value of an algorithm setting identified by its name.

Declaration Syntax
public object get_Setting(string bsSetting)

Parameters
bsSetting(string)
Name of the algorithm setting.

put_Setting(string, object)
Sets the value of an algorithm setting identified by its name.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

431

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public void put_Setting(string bsSetting, object vntVal)

Parameters
bsSetting(string)
Name of the algorithm setting.
vntVal(object)
New value of the algorithm setting.

Run()
Runs the method.

Declaration Syntax
public void Run()

IOptimizationPoint
IOptimizationPoint is the interface describing a point in the parametric space. The point is defined by
its input parameter values, and provides output parameter values when up-to-date.

Declaration Syntax
public interface IOptimizationPoint
Table 283: Members
Property Feasible

Returns the feasibility state of the point with respect to the


defined constraints.

Property ID

Returns the identifier of the point.

Property ParetoFrontIndex

Returns the Pareto front index of the point. Only used if the
optimization method supports Pareto front result type
(ePPT_FeasibilityAndParetoFronts).

Property State

Returns the point state.

Property StateMessage

Returns the message detailing the current point state.

Method get_Value(string)

Returns the variable value.

Method put_Value(string, object)

Sets the variable value.

Feasible
Returns the feasibility state of the point with respect to the defined constraints.

Declaration Syntax
public bool Feasible { set;get; }

432

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationPoint

ID
Returns the identifier of the point.

Declaration Syntax
public string ID { set;get; }

ParetoFrontIndex
Returns the Pareto front index of the point. Only used if the optimization method supports Pareto front
result type (ePPT_FeasibilityAndParetoFronts).

Declaration Syntax
public int ParetoFrontIndex { set;get; }

State
Returns the point state.

Declaration Syntax
public enumPointState State { set;get; }

StateMessage
Returns the message detailing the current point state.

Declaration Syntax
public string StateMessage { set;get; }

get_Value(string)
Returns the variable value.

Declaration Syntax
public object get_Value(string bsVariableID)

Parameters
bsVariableID(string)
Variable identifier.

put_Value(string, object)
Sets the variable value.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

433

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public void put_Value(string bsVariableID, object vntNewVal)

Parameters
bsVariableID(string)
Variable identifier.
vntNewVal(object)
Variable value.

IOptimizationServices
IOptimizationServices is the interface implemented by a DX object and made available to the IOptimizationMethod to let it access services to calculate points, publish progress, etc.

Declaration Syntax
public interface IOptimizationServices
Table 284: Members
Property ExistingPoints

Returns the list of up-to-date points


available to the method before the
beginning of the process.

Property Stopped

Returns True if the user has


requested to stop the process, False
otherwise.

Method CalculateParameterRelationshipsFromPoint(IPoint)

Calculates the parameter relationship


values for a point. The point must
provide a value for each input
parameter. The parameter
relationship values are set on
successful calculation, which is
indicated by the state of the point.

Method CalculateParameterRelationshipsFromPoints(IListCpp) Calculates the parameter relationship


values for a list of points. The points
must provide a value for each of
input parameter. The parameter
relationship values are set on
successful calculation, which is
indicated by the state of the points.
Method CalculatePoint(IPoint)

434

Calculates the output parameter


values for a point. The point must
provide a value for each input
parameter. The output parameter
values are set on successful
calculation, which is indicated by the
state of the point.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationServices
Method CalculatePoints(IListCpp)

Calculates the output parameter


values for a list of points. The points
must provide a value for each of
input parameter. The output
parameter values are set on
successful calculation, which is
indicated by the state of the points.

Method PublishLogMessage(string)

Publishes a message to the log file


produced for each method run.

Method PublishProgress(string, int)

Publishes progress details to


contribute to the user feedback.

Method PushConvergenceData(IConvergenceData)

Pushes convergence data to appear


on the Convergence Criteria chart.

Method PushHistoryPoint(IOptimizationPoint)

Promotes an optimization point to


appear on the History charts.

Method PushHistoryPoints(IListCpp)

Promotes a list of optimization points


to appear on the History charts.

ExistingPoints
Returns the list of up-to-date points available to the method before the beginning of the process.

Declaration Syntax
public IListCpp ExistingPoints { get; }

Stopped
Returns True if the user has requested to stop the process, False otherwise.

Declaration Syntax
public bool Stopped { get; }

CalculateParameterRelationshipsFromPoint(IPoint)
Calculates the parameter relationship values for a point. The point must provide a value for each input
parameter. The parameter relationship values are set on successful calculation, which is indicated by
the state of the point.

Declaration Syntax
public void CalculateParameterRelationshipsFromPoint(IPoint pPoint)

Parameters
pPoint(IPoint)
Point to process.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

435

Ansys.DesignXplorer.API.Optimization Namespace

CalculateParameterRelationshipsFromPoints(IListCpp)
Calculates the parameter relationship values for a list of points. The points must provide a value for
each of input parameter. The parameter relationship values are set on successful calculation, which is
indicated by the state of the points.

Declaration Syntax
public void CalculateParameterRelationshipsFromPoints(IListCpp pPoints)

Parameters
pPoints(IListCpp)
List of points to process.

CalculatePoint(IPoint)
Calculates the output parameter values for a point. The point must provide a value for each input
parameter. The output parameter values are set on successful calculation, which is indicated by the
state of the point.

Declaration Syntax
public void CalculatePoint(IPoint pPoint)

Parameters
pPoint(IPoint)
Point to calculate.

CalculatePoints(IListCpp)
Calculates the output parameter values for a list of points. The points must provide a value for each of
input parameter. The output parameter values are set on successful calculation, which is indicated by
the state of the points.

Declaration Syntax
public void CalculatePoints(IListCpp pPoints)

Parameters
pPoints(IListCpp)
List of points to calculate.

PublishLogMessage(string)
Publishes a message to the log file produced for each method run.

Declaration Syntax
public void PublishLogMessage(string bsMessage)

436

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IOptimizationServices

Parameters
bsMessage(string)
The message to be published.

PublishProgress(string, int)
Publishes progress details to contribute to the user feedback.

Declaration Syntax
public void PublishProgress(string bsMessage, int iIncrementWorkUnits)

Parameters
bsMessage(string)
Short description of the current step.
iIncrementWorkUnits(int)
Positive increment to the number of achieved work units. The total number of work units for the complete
method run is 100. For instance, if 10 work units were already achieved and iIncrementWorkUnits=15, the
user interface will report a progress of 25%.

PushConvergenceData(IConvergenceData)
Pushes convergence data to appear on the Convergence Criteria chart.

Declaration Syntax
public void PushConvergenceData(IConvergenceData pData)

Parameters
pData(IConvergenceData)
Convergence criteria values.

PushHistoryPoint(IOptimizationPoint)
Promotes an optimization point to appear on the History charts.

Declaration Syntax
public void PushHistoryPoint(IOptimizationPoint pPoint)

Parameters
pPoint(IOptimizationPoint)
Promoted history point.

PushHistoryPoints(IListCpp)
Promotes a list of optimization points to appear on the History charts.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

437

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public void PushHistoryPoints(IListCpp pPoints)

Parameters
pPoints(IListCpp)
Promoted list of history points.

IUserOptimizer
IUserOptimizer defines a collection of properties reflecting both the attributes of the optimizer, as
defined in the extension's xml file, and the current values for the corresponding properties. For instance,
it provides the value of the capability MaximumNumberOfInputParameters which can be checked against
the actual number of defined input parameters in the optimization study (property NumberOfInputParametersDefined). An object implementing IUserOptimizer is passed to each callback declared in the extension.

Declaration Syntax
public interface IUserOptimizer
Table 285: Members
Property BasedOnDirectOptimizationOnly

Value of the BasedOnDirectOptimizationOnly


attribute of the optimizer. True if the optimizer
is only available in the context of a Direct
Optimization component.

Property BasedOnResponseSurfaceOnly

Value of the BasedOnResponseSurfaceOnly


attribute of the optimizer. True if the optimizer
is only available in the context of a Response
Surface component.

Property ConstraintHandling

Value of the ConstraintHandling attribute of the


optimizer. Indicates if Constraint Handling is
supported.

Property ConstraintImportance

Value of the ConstraintImportance attribute of


the optimizer. Indicates if the Importance
property of a constraint is supported.

Property ConstraintOnInputParameter

Value of the ConstraintOnInputParameter


attribute of the optimizer. Indicates if constraints
defined on an Input Parameter are supported.

Property ConvergenceData

Value of the ConvergenceData attribute of the


optimizer. Indicates if convergence data are
supported.

Property EqualToConstraint

Value of the EqualToConstraint attribute of the


optimizer. Indicates if the Equal To constraint
type is supported.

Property EqualToConstraintDefined

Actual number of Equal To constraints defined


in the optimization study.

438

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserOptimizer
Property GreaterThanConstraint

Value of the GreaterThanConstraint attribute of


the optimizer. Indicates if the Greater Than
constraint type is supported.

Property GreaterThanConstraintDefined

Actual number of Greater Than constraints


defined in the optimization study.

Property HistoryChartXAxisType

Value of the HistoryChartXAxisType attribute of


the optimizer. Defines the X axis type for history
charts.

Property InsideBoundsConstraint

Value of the InsideBoundsConstraint attribute


of the optimizer. Indicates if the Inside Bounds
constraint type is supported.

Property InsideBoundsConstraintDefined

Actual number of Inside Bounds constraints


defined in the optimization study.

Property IsDirectOptimization

True if the optimization study is defined in a


Direct Optimization context, False if defined in
a Response Surface context.

Property LessThanConstraint

Value of the LessThanConstraint attribute of the


optimizer. Indicates if the Less Than constraint
type is supported.

Property LessThanConstraintDefined

Actual number of Less Than constraints defined


in the optimization study.

Property LogFile

Value of the LogFile attribute of the optimizer.


Indicates if the optimizer provides messages to
generate a log file.

Property MaximizeObjective

Value of the MaximizeObjective attribute of the


optimizer. Indicates if the Maximize objective
type is supported.

Property MaximizeObjectiveDefined

Actual number of Maximize objectives defined


in the optimization study.

Property MaximumNumberOfConstraints

Value of the MaximumNumberOfConstraints


attribute of the optimizer. Defines the maximum
number of constraints supported by the
optimizer.

Property MaximumNumberOfDoubleListParameters Value of the


MaximumNumberOfDoubleListParameters
attribute of the optimizer. Indicates the
maximum number of double list parameters
supported.
Property MaximumNumberOfDoubleParameters

Value of the
MaximumNumberOfDoubleParameters attribute
of the optimizer. Indicates the maximum number
of double parameters supported.

Property MaximumNumberOfInputParameters

Value of the MaximumNumberOfInputParameters


attribute of the optimizer. Indicates the
maximum number of input parameters
supported.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

439

Ansys.DesignXplorer.API.Optimization Namespace
Property MaximumNumberOfIntegerListParameters Value of the
MaximumNumberOfIntegerListParameters
attribute of the optimizer. Indicates the
maximum number of integer list parameters
supported.
Property MaximumNumberOfObjectives

Value of the MaximumNumberOfObjectives


attribute of the optimizer. Defines the maximum
number of objectives supported by the
optimizer.

Property MinimizeObjective

Value of the MinimizeObjective attribute of the


optimizer. Indicates if the Minimize objective
type is supported.

Property MinimizeObjectiveDefined

Actual number of Minimize objectives defined


in the optimization study.

Property MinimumNumberOfConstraints

Value of the MinimumNumberOfConstraints


attribute of the optimizer. Defines the minimum
number of constraints required.

Property MinimumNumberOfObjectives

Value of the MinimumNumberOfObjectives


attribute of the optimizer. Defines the minimum
number of objectives required.

Property NumberOfConstraintsDefined

Actual number of constraints defined in the


optimization study.

Property NumberOfConstraintsDefinedOnInputs

Actual number of constraints defined on input


parameters in the optimization study.

Property NumberOfDoubleListParametersDefined

Actual number of double list parameters defined


in the optimization study.

Property NumberOfDoubleParametersDefined

Actual number of double parameters defined in


the optimization study.

Property NumberOfInputParametersDefined

Actual number of input parameters defined in


the optimization study.

Property NumberOfIntegerListParametersDefined

Actual number of integer list parameters defined


in the optimization study.

Property NumberOfObjectivesDefined

Actual number of objectives defined in the


optimization study.

Property NumberOfObjectivesDefinedOnInputs

Actual number of objectives defined on input


parameters in the optimization study.

Property ObjectiveImportance

Value of the ObjectiveImportance attribute of


the optimizer. Indicates if the Importance
property of an objective is supported.

Property ObjectiveOnInputParameter

Value of the ObjectiveOnInputParameter


attribute of the optimizer. Indicates if objectives
defined on an Input Parameter are supported.

Property ParameterRelationship

Value of the ParameterRelationship attribute of


the optimizer. Indicates if parameter
relationships are supported.

440

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserOptimizer
Property SeekObjective

Value of the SeekObjective attribute of the


optimizer. Indicates if the Seek objective type is
supported.

Property SeekObjectiveDefined

Actual number of Seek objectives defined in the


optimization study.

Property StartingPointRequired

Value of the StartingPointRequired attribute of


the optimizer. Indicates if the optimizer requires
a starting point.

BasedOnDirectOptimizationOnly
Value of the BasedOnDirectOptimizationOnly attribute of the optimizer. True if the optimizer is only
available in the context of a Direct Optimization component.

Declaration Syntax
public bool BasedOnDirectOptimizationOnly { set;get; }

BasedOnResponseSurfaceOnly
Value of the BasedOnResponseSurfaceOnly attribute of the optimizer. True if the optimizer is only
available in the context of a Response Surface component.

Declaration Syntax
public bool BasedOnResponseSurfaceOnly { set;get; }

ConstraintHandling
Value of the ConstraintHandling attribute of the optimizer. Indicates if Constraint Handling is supported.

Declaration Syntax
public bool ConstraintHandling { set;get; }

ConstraintImportance
Value of the ConstraintImportance attribute of the optimizer. Indicates if the Importance property of a
constraint is supported.

Declaration Syntax
public bool ConstraintImportance { set;get; }

ConstraintOnInputParameter
Value of the ConstraintOnInputParameter attribute of the optimizer. Indicates if constraints defined on
an Input Parameter are supported.

Declaration Syntax
public bool ConstraintOnInputParameter { set;get; }
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

441

Ansys.DesignXplorer.API.Optimization Namespace

ConvergenceData
Value of the ConvergenceData attribute of the optimizer. Indicates if convergence data are supported.

Declaration Syntax
public bool ConvergenceData { set;get; }

EqualToConstraint
Value of the EqualToConstraint attribute of the optimizer. Indicates if the Equal To constraint type is
supported.

Declaration Syntax
public bool EqualToConstraint { set;get; }

EqualToConstraintDefined
Actual number of Equal To constraints defined in the optimization study.

Declaration Syntax
public bool EqualToConstraintDefined { get; }

GreaterThanConstraint
Value of the GreaterThanConstraint attribute of the optimizer. Indicates if the Greater Than constraint
type is supported.

Declaration Syntax
public bool GreaterThanConstraint { set;get; }

GreaterThanConstraintDefined
Actual number of Greater Than constraints defined in the optimization study.

Declaration Syntax
public bool GreaterThanConstraintDefined { get; }

HistoryChartXAxisType
Value of the HistoryChartXAxisType attribute of the optimizer. Defines the X axis type for history charts.

Declaration Syntax
public string HistoryChartXAxisType { set;get; }

442

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserOptimizer

InsideBoundsConstraint
Value of the InsideBoundsConstraint attribute of the optimizer. Indicates if the Inside Bounds constraint
type is supported.

Declaration Syntax
public bool InsideBoundsConstraint { set;get; }

InsideBoundsConstraintDefined
Actual number of Inside Bounds constraints defined in the optimization study.

Declaration Syntax
public bool InsideBoundsConstraintDefined { get; }

IsDirectOptimization
True if the optimization study is defined in a Direct Optimization context, False if defined in a Response
Surface context.

Declaration Syntax
public bool IsDirectOptimization { get; }

LessThanConstraint
Value of the LessThanConstraint attribute of the optimizer. Indicates if the Less Than constraint type is
supported.

Declaration Syntax
public bool LessThanConstraint { set;get; }

LessThanConstraintDefined
Actual number of Less Than constraints defined in the optimization study.

Declaration Syntax
public bool LessThanConstraintDefined { get; }

LogFile
Value of the LogFile attribute of the optimizer. Indicates if the optimizer provides messages to generate
a log file.

Declaration Syntax
public bool LogFile { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

443

Ansys.DesignXplorer.API.Optimization Namespace

MaximizeObjective
Value of the MaximizeObjective attribute of the optimizer. Indicates if the Maximize objective type is
supported.

Declaration Syntax
public bool MaximizeObjective { set;get; }

MaximizeObjectiveDefined
Actual number of Maximize objectives defined in the optimization study.

Declaration Syntax
public bool MaximizeObjectiveDefined { get; }

MaximumNumberOfConstraints
Value of the MaximumNumberOfConstraints attribute of the optimizer. Defines the maximum number
of constraints supported by the optimizer.

Declaration Syntax
public int MaximumNumberOfConstraints { set;get; }

MaximumNumberOfDoubleListParameters
Value of the MaximumNumberOfDoubleListParameters attribute of the optimizer. Indicates the maximum
number of double list parameters supported.

Declaration Syntax
public int MaximumNumberOfDoubleListParameters { set;get; }

MaximumNumberOfDoubleParameters
Value of the MaximumNumberOfDoubleParameters attribute of the optimizer. Indicates the maximum
number of double parameters supported.

Declaration Syntax
public int MaximumNumberOfDoubleParameters { set;get; }

MaximumNumberOfInputParameters
Value of the MaximumNumberOfInputParameters attribute of the optimizer. Indicates the maximum
number of input parameters supported.

Declaration Syntax
public int MaximumNumberOfInputParameters { set;get; }

444

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserOptimizer

MaximumNumberOfIntegerListParameters
Value of the MaximumNumberOfIntegerListParameters attribute of the optimizer. Indicates the maximum
number of integer list parameters supported.

Declaration Syntax
public int MaximumNumberOfIntegerListParameters { set;get; }

MaximumNumberOfObjectives
Value of the MaximumNumberOfObjectives attribute of the optimizer. Defines the maximum number
of objectives supported by the optimizer.

Declaration Syntax
public int MaximumNumberOfObjectives { set;get; }

MinimizeObjective
Value of the MinimizeObjective attribute of the optimizer. Indicates if the Minimize objective type is
supported.

Declaration Syntax
public bool MinimizeObjective { set;get; }

MinimizeObjectiveDefined
Actual number of Minimize objectives defined in the optimization study.

Declaration Syntax
public bool MinimizeObjectiveDefined { get; }

MinimumNumberOfConstraints
Value of the MinimumNumberOfConstraints attribute of the optimizer. Defines the minimum number
of constraints required.

Declaration Syntax
public int MinimumNumberOfConstraints { set;get; }

MinimumNumberOfObjectives
Value of the MinimumNumberOfObjectives attribute of the optimizer. Defines the minimum number
of objectives required.

Declaration Syntax
public int MinimumNumberOfObjectives { set;get; }

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

445

Ansys.DesignXplorer.API.Optimization Namespace

NumberOfConstraintsDefined
Actual number of constraints defined in the optimization study.

Declaration Syntax
public int NumberOfConstraintsDefined { get; }

NumberOfConstraintsDefinedOnInputs
Actual number of constraints defined on input parameters in the optimization study.

Declaration Syntax
public int NumberOfConstraintsDefinedOnInputs { get; }

NumberOfDoubleListParametersDefined
Actual number of double list parameters defined in the optimization study.

Declaration Syntax
public int NumberOfDoubleListParametersDefined { get; }

NumberOfDoubleParametersDefined
Actual number of double parameters defined in the optimization study.

Declaration Syntax
public int NumberOfDoubleParametersDefined { get; }

NumberOfInputParametersDefined
Actual number of input parameters defined in the optimization study.

Declaration Syntax
public int NumberOfInputParametersDefined { get; }

NumberOfIntegerListParametersDefined
Actual number of integer list parameters defined in the optimization study.

Declaration Syntax
public int NumberOfIntegerListParametersDefined { get; }

NumberOfObjectivesDefined
Actual number of objectives defined in the optimization study.

446

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

IUserOptimizer

Declaration Syntax
public int NumberOfObjectivesDefined { get; }

NumberOfObjectivesDefinedOnInputs
Actual number of objectives defined on input parameters in the optimization study.

Declaration Syntax
public int NumberOfObjectivesDefinedOnInputs { get; }

ObjectiveImportance
Value of the ObjectiveImportance attribute of the optimizer. Indicates if the Importance property of an
objective is supported.

Declaration Syntax
public bool ObjectiveImportance { set;get; }

ObjectiveOnInputParameter
Value of the ObjectiveOnInputParameter attribute of the optimizer. Indicates if objectives defined on
an Input Parameter are supported.

Declaration Syntax
public bool ObjectiveOnInputParameter { set;get; }

ParameterRelationship
Value of the ParameterRelationship attribute of the optimizer. Indicates if parameter relationships are
supported.

Declaration Syntax
public bool ParameterRelationship { set;get; }

SeekObjective
Value of the SeekObjective attribute of the optimizer. Indicates if the Seek objective type is supported.

Declaration Syntax
public bool SeekObjective { set;get; }

SeekObjectiveDefined
Actual number of Seek objectives defined in the optimization study.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

447

Ansys.DesignXplorer.API.Optimization Namespace

Declaration Syntax
public bool SeekObjectiveDefined { get; }

StartingPointRequired
Value of the StartingPointRequired attribute of the optimizer. Indicates if the optimizer requires a
starting point.

Declaration Syntax
public bool StartingPointRequired { set;get; }

448

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Ansys.DesignXplorer.API Namespace
Declaration Syntax
namespace Ansys.DesignXplorer.API
Table 286: Members
ParameterNature Enumeration of the possible nature of a
parameter.

ParameterNature
Enumeration of the possible nature of a parameter.

Declaration Syntax
public enum ParameterNature
Table 287: Members
Member Continuous Continuous
Member Discrete

Discrete

Member Usability

Obsolete. Instead of defining a usability parameter, define a continuous


parameter with the UseManufacturableValues set to True.

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

449

450

Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

You might also like