Академический Документы
Профессиональный Документы
Культура Документы
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.
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.
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
iv
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
vi
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
vii
viii
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
ix
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xi
xii
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xiii
xiv
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xv
xvi
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xvii
xviii
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xix
xx
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxi
xxii
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxiii
xxiv
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxv
xxvi
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxvii
xxviii
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxix
xxx
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxxi
xxxii
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxxiii
xxxiv
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxxv
xxxvi
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
xxxvii
xxxviii
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.
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
Property Keys
Method Clone()
Method Contains(string)
Method GetStringValue(string)
Method GetValue(string)
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
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
IMechanicalUserLoad
IMechanicalUserSolver
MechanicalPanelEnum
IMechanicalDataModel
Defines the data model of the Mechanical application.
Declaration Syntax
public interface IMechanicalDataModel
Table 7: Members
Property Project
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()
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
Member Graph
Member Graphics
Member Outline
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
IDesignModelerExtAPI
IDesignModelerGeoData
IDesignModelerGeoFeature
IGeometryBuilder
IIntersect
IOperations
IOperationTools
IPrimitives
IPSGeoBody
Defines a body.
IPSGeoEdge
Defines an edge.
IPSGeoEntity
IPSGeoFace
Defines a face.
IPSGeoPart
Defines a part.
IQueries
IRevolve
ISheetCone
ISheetCylinder
ISheetPolygon
ISheets
ISheetSphere
ISolidBox
ISolidCone
ISolidCylinder
ISolids
ISolidSphere
13
Ansys.ACT.Interfaces.DesignModeler Namespace
ISubtract
IUnion
IWireArc
IWireBCurve
IWireEllipse
IWirePolyline
IWires
IDesignModelerDataModel
Defines the DesignModeler data model.
Declaration Syntax
public interface IDesignModelerDataModel
Table 12: Members
Property Components
Property GeoData
Property GeometryBuilder
Property Queries
Method ComponentById(int)
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
Property MaterialType
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
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
Property Direction
Property Walled
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
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
Property Tools
Method CreateExtrudeOperation(IEnumerable<double>,
double)
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>)
Method DeleteBody(IPSGeoBody)
Deletes a body.
Method OffsetFace(IEnumerable<IPSGeoFace>,
double)
Method SheetBodyToSolidBody(IPSGeoBody)
Method SimplifyTopology(IPSGeoEntity)
Method ThickenBody(IPSGeoBody,
IEnumerable<IPSGeoFace>, double, double)
Transform a body.
Method WireToSheetBody(IPSGeoBody)
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.
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
Property Wire
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>)
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)
Method Distance(IEnumerable<IPSGeoEntity>,
IEnumerable<IPSGeoEntity>)
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
Property Axis
Property Origin
Property Walled
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
Property Radius2
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
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)
Method CreatePolygon(IEnumerable<double>)
32
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
ISheetSphere
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
Property Radius2
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
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)
Method CreateCylinder(IEnumerable<double>,
IEnumerable<double>, double)
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)
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.
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.
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
Property EndAngle
Property Normal
Property Radius
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
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>)
Method CreateBCurve(IEnumerable<double>)
Method CreatePolyline(IEnumerable<double>)
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
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.
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
Property Comments
Property Figures
Property InputArgument1
Property InputArgument2
Property InputArgument3
Property InputArgument4
Property InputArgument5
Property InputArgument6
Property InputArgument7
Property InputArgument8
Property InputArgument9
Property SnippetFilePath
Property Suppressed
Method AddComment()
Method AddFigure()
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
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
Property Comments
Property Figures
Property Geometry
Property ImportedFromCAD
Property RelativeTolerance
Property SendToSolver
Property ToleranceType
Property TotalSelection
Property UsedByMeshWorksheet
Property Visible
Property ZeroTolerance
Method AddComment()
Method AddFigure()
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
Property Comments
Property Components
Property Figures
Property GenerateOnRefresh
Property ShowAnnotations
Method AddComment()
Method AddFigure()
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
Property FutureIntent
Property GeometrySelection
Property InterfaceMethod
Property InteriorConnections
Property MaxFrequency
Property MinFrequency
Property NumberOfModes
Property NumInterfaceEntries
Property NumMasterNodes
Property Physics
Property RangeSearch
Property 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
Property SolutionNameMode
Property SolverFilesDirectory
Property Suppressed
Property 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
Property Comments
Property Figures
Property Paths
Property ShowMesh
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
Property Comments
Property EulerAngleYZ
Property EulerAngleZX
Property 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
Property IsGlobal
Property ReadOnly
Property Suppressed
Method AddComment()
Method AddFigure()
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
Property Comments
Method AddComment()
Method AddFigure()
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
Property Children
Property Comments
Property Figures
Property Solution
Property SolverName
Property SystemCaption
Property Temperature
Property WorkingDir
Method AddComment()
Method AddEarthGravity()
Method AddFigure()
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
Property Comments
Property Text
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
Property AdvancedSizeFunction
Property AutomaticInflation
Property AutoMeshDefeaturing
Property Children
Property Comments
Property DefeatureTolerance
Property DisplayStyle
Property ElementCount
Property ElementOrder
Property ElementSize
Property ExpansionFactor
Property ExtraRetriesForAssembly
Property Figures
Property GrowthRateSF
Property InflationAlgorithm
Property InflationOption
Property InitialSizeSeed
Property MaxFaceElementSize
Property MaximumLayers
Property MaxSizeSF
Property MeshControls
Property MeshMetric
Property MeshMetricAverage
Property MeshMetricMax
Property MeshMetricMin
Property MeshMetricSTDV
Property MeshMorphing
Property MinEdgeSize
Property MinSizeSF
Property NodeCount
Property 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
Property PhysicsPreference
Property PinchGenerateOnRefresh
Property PinchTolerance
Property Relevance
Property RelevanceCenter
Property RigidBodyBehavior
Property ShapeChecking
Property SmoothingOption
Property SolverPreference
Property SpanAngleOption
Property SpanningAngleSF
Property StraightSideElement
Property TopologyChecks
Property TransitionOption
Property TransitionRatio
Property TriangleSurfaceMesh
Method AddComment()
Method AddFigure()
Method AddInflationMeshControl()
Method AddMatchMeshControl()
Method AddMethodMeshControl()
Method AddPinchMeshControl()
Method AddRefinementMeshControl()
Method AddSizingMeshControl()
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
Property Children
Property Comments
Property ComponentGroup
Property ConnectionGroup
Property CoordinateSystemGroup
Property Environments
Property Figures
Property MeshControlGroup
Property PrototypeGroup
Property Prototypes
Property RemotePointGroup
Property SystemCaption
Method AddComment()
Method AddFigure()
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
Property Comments
Property CoordinateSystemSelection
Property EdgeSelection
Property EndCoordinateSystemSelection
Property EndLocationX
Property EndLocationY
Property EndLocationZ
Property Figures
Property HasValidGeometrySelection
Property NumberOfSamplingPoints
Property PathScopingType
Property ShowMesh
Property SnapToMesh
Property StartLocationY
Property StartLocationZ
Property Suppressed
Method AddComment()
Method AddFigure()
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
Property Behavior
Property Children
Property Comments
Property CoordinateSystem
Property IsDistributedMass
Property Mass
Property MassMomentOfInertiaX
Property MassMomentOfInertiaY
Property MassMomentOfInertiaZ
Property MassPerUnitArea
Property PinballSize
Property Prototypes
Property RemotePoint
Property Scope
Property Suppressed
Property ThermalCapacitance
Property TotalMass
Method AddComment()
Method AddFigure()
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
Property Children
Property Comments
Property CreationDate
Property CreationTime
Property Models
Property PreparedFor
Property Subject
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
Property BoundingBoxLengthY
Property BoundingBoxLengthZ
Property Children
Property Comments
Property CoordinateSystem
Property CrossSectionArea
Property Elements
Property Figures
Property IsWindingBody
Property Mass
Property MassCentroidX
Property MassCentroidY
Property MassCentroidZ
Property MassMomentOfInertiaP1
Property MassMomentOfInertiaP2
Property MassMomentOfInertiaP3
Property MaterialAssignment
Property MeshMetric
Property Nodes
Property NonlinearMaterialEffects
Property ReadOnly
Property ReferenceTemperature
Property StiffnessBehavior
Property Suppressed
Property ThicknessMode
Property UseReferenceTemperature
Property 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
Property Visible
Property Volume
Property WireLength
Method AddComment()
Method AddFigure()
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
Property BoundingBoxLengthY
Property BoundingBoxLengthZ
Property CADAttribPrefixes
Property 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
Property CanChangeCADUnits
Property Children
Property Comments
Property DoSmartUpdate
Property Elements
Property FiberLength
Property Figures
Property ImportCoordinateSystems
Gets the
ImportCoordinateSystems.
Property ImportEnclosureAndSymmetry
Gets the
ImportEnclosureAndSymmetry.
Property ImportSheets
Property ImportSolids
Property ImportWires
Property Mass
Property MeshVolume
Property Model2DBehavior
Property Nodes
Property NumActiveParts
Property NumParts
Property PointMasses
Property Prototypes
Property SurfaceArea
Property UseCADAssociativity
Property UseCADAttribTrans
Property UseCADNamedSelTrans
Property Volume
Property XCentroid
Property YCentroid
Property ZCentroid
Method AddComment()
Method AddFigure()
Method AddPointMass()
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
Property Children
Property Comments
Property DOFSelection
Property GloballyAvailable
Property LocationX
Property LocationY
Property LocationZ
Property PinballSize
Property RotationXActiveOrInactive
Property RotationYActiveOrInactive
Property RotationZActiveOrInactive
Property Scope
Property Suppressed
Method AddComment()
Method GetMeshRegion()
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
Property Comments
Property RemotePoints
Property ShowLines
Method AddComment()
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
Property Children
Property Comments
Property Figures
Property Results
Property WorkingDir
Method AddComment()
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
Property Comments
Property DisplayTime
Property Figures
Property GeometrySelection
Property 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
Property Minimum
Property SetDriver
Property Suppressed
Property 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
Property 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
Property Figures
Property GeometrySelection
Property Identifier
Property SetDriver
Property Suppressed
Method AddComment()
Method AddFigure()
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
AutoDetectionType
AutoOrManual
CommandEditorTarget
CondensedPartInterfaceMethod
Specifies the
CondensedPartInterfaceMethod.
CondensedPartPhysics
CondensedPartReductionMethod
Specifies the
CondensedPartReductionMethod.
ConnectionScopingType
ContactBehavior
ContactCorrection
ContactDetectionPoint
ContactEdgeEdgeOption
ContactElasticSlipToleranceType
Specifies the
ContactElasticSlipToleranceType.
ContactFaceEdgeOption
ContactFaceEdgePriority
ContactFormulationType
ContactGroupingType
ContactInitialEffect
ContactOrientation
ContactPenetrationToleranceType
Specifies the
ContactPenetrationToleranceType.
ContactPinballType
ContactSearchingType
ContactToleranceType
ContactTrimType
ContactType
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
CrossSectionType
DeformationType
DistributedMassInputType
DOFSelectionType
FutureIntent
GeometryDefineByType
GeometryType
JointInitialPosition
JointScopingType
JointSolverElementType
JointStopType
JointType
LoadBehaviorType
MeshDisplayStyle
Model2DBehavior
PathScoping
RemoteApplicationType
RotationPlane
SetDriverStyle
SpringBehavior
SpringPreloadType
SpringResultType
SpringScopingType
SpringStiffnessType
SpringType
StiffnessBehavior
TargetCorrection
TargetOrientation
ToleranceType
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.
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.
CondensedPartInterfaceMethod
Specifies the CondensedPartInterfaceMethod.
Declaration Syntax
public enum CondensedPartInterfaceMethod
Table 70: Members
Member Fixed
Fixed.
Member Free
Free.
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.
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.
ContactBehavior
Specifies the ContactBehavior.
Declaration Syntax
public enum ContactBehavior
Table 74: Members
Member Asymmetric
Asymmetric.
Member AutoAsymmetric
AutoAsymmetric.
Symmetric.
ContactCorrection
Specifies the ContactCorrection.
Declaration Syntax
public enum ContactCorrection
Table 75: Members
Member Bolt
Bolt.
Member No
No.
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.
Value.
ContactFaceEdgeOption
Specifies the ContactFaceEdgeOption.
Declaration Syntax
public enum ContactFaceEdgeOption
Table 79: Members
Member IfNoFaceFace
IfNoFaceFace.
Member No
No.
Member OnlySolidEdges
OnlySolidEdges.
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.
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.
Sphere.
ContactPenetrationToleranceType
Specifies the ContactPenetrationToleranceType.
Declaration Syntax
public enum ContactPenetrationToleranceType
Table 85: Members
Member Factor
Factor.
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.
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.
ContactType
Specifies the ContactType.
Declaration Syntax
public enum ContactType
Table 90: Members
Member Bonded
Bonded.
Member BondedInitial
BondedInitial.
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.
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.
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.
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.
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.
JointSolverElementType
Specifies the JointSolverElementType.
Declaration Syntax
public enum JointSolverElementType
Table 102: Members
Member ContactDirect
ContactDirect.
Member Element
Element.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
TargetOrientation
Specifies the TargetOrientation.
Declaration Syntax
public enum TargetOrientation
Table 120: Members
Member Circle
Circle.
Member Cylinder
Cylinder.
Sphere.
ToleranceType
Specifies the ToleranceType.
Declaration Syntax
public enum ToleranceType
Table 121: Members
Member Manual
Manual.
UpdateContactStiffness
Specifies the UpdateContactStiffness.
Declaration Syntax
public enum UpdateContactStiffness
Table 122: Members
Member EachEquilibriumIteration
EachEquilibriumIteration.
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)
Property
Center
Property
Direction
Property
Radius
Method
Generate()
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
Property Comments
Property 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
Property Suppressed
Property 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
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
Property ConstrainBoundary
Property Figures
Property GeometrySelection
Property NumberOfDivisions
Property SpecifiedCorners
Property SpecifiedEnds
Property SpecifiedSides
Property Suppressed
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
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
Property Comments
Property Figures
Property FirstLayerHeight
Property GeometrySelection
Property GrowthRate
Property InflationAlgorithm
Property InflationOption
Property MaximumLayers
Property Suppressed
Property 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
Property Comments
Property ControlMessages
Property Figures
Property HighCoordinateSystem
Property LowGeometrySelection
Property RotationAxis
Property Suppressed
Property 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
Property Comments
Property Figures
Property Suppressed
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
Property ApproxNumElements
Property BFCartCoordSys
Property BFCartSpacingOption
Property BFCartSubType
Property BFCartTolerance
Property Children
Property Comments
Property ControlMessages
Property CurvatureNormalAngle
Property DefeaturingTolerance
Property ElementMidsideNodes
Property FeatureAngle
Property Figures
Property FreeFaceMeshType
Property 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
Property Location
Property MappedMeshType
Property MaxElementSize
Property Method
Property MethodElementOption
Property MinEdgeSize
Property MinElementSize
Property NDiv
Property NumCellsAcrossGap
Property PreserveBoundaries
Property ProjectionFactor
Property Refinement
Property ReuseBlocking
Property SourceGeometry
Property SourceTargetSelection
Property Suppressed
Property SurfaceMeshMethod
Property SweepBiasType
Property SweepBiasValue
Property SweepEdges
Property SweepElementSize
Property SweepESizeType
Property SweepSizeBehavior
Property TargetGeometry
Property TetraGrowthRate
Property TetraTransition
Property 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
Property Comments
Property Figures
Property MasterGeometry
Property SlaveGeometry
Property Suppressed
Property 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
Property Comments
Property Figures
Property Location
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
Property BiasEdges
Property BiasFactor
Property BiasGrowthRate
Property BiasOption
Property BiasType
Property Children
Property Comments
Property CurvatureAngle
Property ElementSize
Property Figures
Property GrowthRate
Property 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
Property SphereCenterX
Property SphereCenterY
Property SphereCenterZ
Property SphereRadius
Property Suppressed
Property 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
Property Name
Property Thin1
Property Thin2
Property 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
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
Property Item
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
Property Id
Property IncludeInLegend
Property Name
Property NumGeometry
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
Property Comments
Property CrossSectionType
Property Figures
Property Hidden
Property MaterialName
Property MobileAppliedBy
Property MobileBehavior
Property MobileBodyName
Property MobileCoordinateSystemSelection
Property 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
Property MobileLocationY
Property MobileLocationZ
Property MobilePinballSize
Property Prototypes
Property Radius
Property ReferenceAppliedBy
Property ReferenceBehavior
Property ReferenceBodyName
Property ReferenceLocationPoint
Property ReferenceLocationX
Property ReferenceLocationY
Property ReferenceLocationZ
Property ReferencePinballSize
Property ScopingType
Property Suppressed
Method AddComment()
Method AddFigure()
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
Property Children
Property Comments
Property DampingC11
Property DampingC12
Property DampingC21
Property DampingC22
Property Figures
Property MobileBehavior
Property MobileBodyName
Property MobileCoordinateSystem
Property MobileLocation
Property MobileLocationX
Property MobileLocationY
Property MobileLocationZ
Property MobilePinballSize
Property Prototypes
Property ReferenceBehavior
Property 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
Property ReferenceRotationPlane
Property ReferenceSet
Property ScopingType
Property StiffnessK11
Property StiffnessK12
Property StiffnessK21
Property StiffnessK22
Property Suppressed
Method AddComment()
Method AddFigure()
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
Property Bearings
Property Children
Property Comments
Property ContactRegions
Property DetectionMode
Property Figures
Property FixedJoints
Property Joints
Property MeshConnections
Property Springs
Property TransparencyEnabled
Method AddComment()
Method AddContactGroup()
Method AddFigure()
Method AddSpring()
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
Property AutoRevoluteJoints
Property BeamConnections
Property 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
Property ContactRegions
Property FaceEdgePriority
Property Figures
Property GeometrySelection
Property GroupingType
Property Joints
Property MinDistanceSlider
Property MinDistanceValue
Property SearchingType
Property Springs
Property Suppressed
Property ToleranceType
Property ToleranceValue
Property UseEdgeEdge
Property UseFaceEdge
Property UseFaceFace
Property UseRange
Method AddComment()
Method AddFigure()
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
Property BeamMaterialName
Property BeamRadius
Property Children
Property 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
Property ContactCorrection
Property ContactEndingPoint
Property ContactFormulation
Property ContactOrientation
Property ContactStartingPoint
Property ContactType
Property DampingFactor
Property DetectionMethod
Property ElasticSlipTolerance
Property ElasticSlipToleranceFactor
Property Figures
Property InterfaceTreatment
Property Mode
Property NormalStiffness
Property PenetrationTolerance
Property PenetrationToleranceFactor
Property PinballFactor
Property PinballRadius
Property PinballType
Property SourceComponentSelection
Property SourceGeometry
Property SourceName
Property Suppressed
Property SymmetricContact
Property TargetCenterPoint
Property TargetComponentSelection
Property TargetCorrection
Property TargetEndingPoint
Property TargetGeometry
Property TargetName
Property TargetOrientation
Property TargetStartingPoint
Property TrimContact
Property TrimTolerance
Property UpdateContactStiffness
Property 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
Property UseAutoPenetrationTolerance
Property UserOffset
Method AddComment()
Method AddFigure()
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
Property Comments
Property Figures
Property InitialPosition
Property JointBehaviorMobile
Property JointBehaviorReference
Property JointPinballSizeMobile
Property JointPinballSizeReference
Property JointScopingType
Property JointStopsRXMax
Property JointStopsRXMaxType
Property JointStopsRXMin
Property JointStopsRXMinType
Property JointStopsRYMax
Property JointStopsRYMaxType
Property JointStopsRYMin
Property 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
Property JointStopsRZMaxType
Property JointStopsRZMin
Property JointStopsRZMinType
Property JointStopsXMax
Property JointStopsXMaxType
Property JointStopsXMin
Property JointStopsXMinType
Property JointStopsYMax
Property JointStopsYMaxType
Property JointStopsYMin
Property JointStopsYMinType
Property JointStopsZMax
Property JointStopsZMaxType
Property JointStopsZMin
Property JointStopsZMinType
Property JointType
Property MobileAppliedBy
Property MobileBodyName
Property MobileCoordinateSystemSelection
Property MobileLocation
Property Prototypes
Property ReferenceAppliedBy
Property ReferenceBodyName
Property SolverElementType
Property Suppressed
Property SuppressedForSolve
Property TortionalDamping
Property TortionalStiffness
Method AddComment()
Method AddFigure()
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
Property Comments
Property Figures
Property Hidden
Property LongitudinalDamping
Property LongitudinalStiffness
Property MobileAppliedBy
Property 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
Property MobileLocation
Property MobileLocationSelection
Property MobileLocationX
Property MobileLocationY
Property MobileLocationZ
Property PreloadLength
Property PreloadLoad
Property Prototypes
Property ReferenceAppliedBy
Property ReferenceBodyName
Property ReferenceLocationSelection
Property ReferenceLocationX
Property ReferenceLocationY
Property ReferenceLocationZ
Property SpringBehavior
Property SpringLength
Property SpringMobileBehavior
Property SpringMobilePinballSize
Property SpringPreloadType
Property SpringReferenceBehavior
Property SpringReferencePinballSize
Property SpringScopingType
Property SpringType
Property Suppressed
Method AddComment()
Method AddFigure()
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
Property
Id
Property
Matrix
Property
Name
Property
Origin
Property
XAxis
Property
YAxis
Property
ZAxis
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
Property Comments
Property Figures
Property Magnitude
Property Suppressed
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
Property Comments
Property CoordinateSystem
Property Figures
Method AddComment()
Method AddFigure()
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
Property Comments
Property Figures
228
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
Property Suppressed
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
ISimProperty
Exposes a property.
ISimPropertyGroup
ISimPropertyTable
IUserLoad
IUserObject
IUserResult
IUserSolver
ObjectLocationEnum
ObjectTypeEnum
PropertyDisplayEnum
IPropertyCollection
Defines a collection of properties.
Declaration Syntax
public interface IPropertyCollection
Table 155: Members
Property Count
Property Item
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
ISimProperty
Property Caption
Property Control
Property Controller
Property DefaultValue
Property Displayed
Property HasUnit
Property Id
Property InternalValue
Property IsGroup
Property IsTable
Property IsValid
Property Name
Property Options
Property ParentCaption
Property ReadOnly
Property UniqueName
Property UnitString
Property Value
Property ValueString
Property 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
Property 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
Property RowCount
Method AddRow()
Method DeleteRow(int)
Method SaveActiveRow()
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
Property Color
Gets or sets the color associated with this entity. This color is used by
default to display the scoped geometry.
Property IsLoad
Property IsSupport
Property Suppressed
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
Property Caption
Property Controller
Property Extension
Property Icon
Property Id
Property Name
Property Properties
Property State
Property Version
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
Property ResultAveraging
Property ResultLocation
Property ResultType
Property Suppressed
Property 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
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.
ObjectTypeEnum
Specifies the object types.
Declaration Syntax
public enum ObjectTypeEnum
Table 164: Members
Member Analysis
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
Member Hidden
Member None
Member Property
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
246
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
ICustomResultReader
IResult
Exposes a result.
IResultCollector
IResultReader
IStepInfo
ResultTypeEnum
StepDefineByEnum
IComponentInfo
Exposes a result component information.
Declaration Syntax
public interface IComponentInfo
Table 169: Members
Property Name
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 unit for the given result name
and component name.
Method GetResultLocation(string)
Method GetResultNames()
Method GetResultType(string)
Method GetStepValues()
Method SetCurrentStep(IStepInfo)
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
Property Location
Property Name
Method GetComponentInfo(string)
Method GetElementValues(int)
Method GetNodeValues(int)
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
Property HasImaginary
Property Ids
Property Indices
Property Lengths
Method ContainsId(int)
Method SetAllValues(double[])
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[])
Method SetImaginaryValues(int,
IEnumerable<double>)
Method SetValues(int,
IEnumerable<double>)
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
Property CurrentTimeFreq
Property HasImaginaryResults Gets a value indicating whether the reader contains imaginary result
values.
Property ListTimeFreq
Property ResultNames
Property ResultSetCount
Method GetResult(string)
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
Property 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
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
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
Member NodalDifference
Member NodalFraction
Computes the ratio of the nodal difference and the nodal average.
Member Unaverage
ResultLocationEnum
Defines the result's location types.
Declaration Syntax
public enum ResultLocationEnum
Table 176: Members
Member Element
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
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
GeoCellTypeEnum
GeoCurveTypeEnum
IBaseGeoBodyOrPart
IBaseGeoEdge
IBaseGeoEntity
IBaseGeoFace
IBaseGeoPart
IBaseGeoVertex
IGeoAssembly
IGeoBody
IGeoData
IGeoEdge
IGeoEntity
IGeoFace
IGeoLoop
Defines a loop.
IGeoPart
Defines a loop.
IGeoShell
Defines a shell.
IGeoTessellation
Defines a tessellation.
IGeoVertex
MaterialTypeEnum
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.
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.
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.
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.
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.
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
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
Property Edges
Property Faces
Property Length
Property Vertices
Property Volume
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
Property Centroid
Property CurveType
Property EndVertex
Property Faces
Property Length
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
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
Property Type
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
Property Bodies
Property Centroid
Property Edges
Property SurfaceType
Property Vertices
Method NormalsAtParams(double[])
Method ParamAtPoint(double[])
Method PointsAtParams(double[])
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
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
Property Faces
Property X
Property Y
Property Z
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
Property Parts
Property Unit
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
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
Property Name
Property Shells
Property Suppressed
Property Thickness
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
Property Extents
Property IsParamReversed
Method ParamAtPoint(double[])
Method PointAtParam(double)
Method PointsAtParams(double[])
Method TangentAtParam(double)
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
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
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
Property Normals
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
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.
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
IEntry
INamed
Defines a toolbar.
IUserInterface
EntryTypeEnum
Specifies the entry type.
Declaration Syntax
public enum EntryTypeEnum
Table 201: Members
Member Button
Button.
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
283
Ansys.ACT.Interfaces.UserInterface Namespace
Property Checked
Property Enabled
Property Entries
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
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
Property Visible
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
Property Toolbars
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
IDraw3DContext
IDrawContext
IFactory2D
IFactory3D
IGraphics
IPoint
Exposes a point.
ITransformation3D
Exposes a 3D transformation.
IVector3D
Exposes a 3D vector.
IWorldPoint
ICamera
Camera.
Declaration Syntax
public interface ICamera
Table 208: Members
Property ZoomFactor
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()
Method LineTo2D(IPoint)
Method MoveTo2D(IPoint)
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.
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
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>)
Method DrawPoints(IEnumerable<double>)
Method DrawPoints(IEnumerable<double>,
double)
Method DrawPolygon(IEnumerable<double>,
IEnumerable<double>)
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[])
Close()
Closes and draw this context. Except for the visibility, a closed context cannot be modified.
Declaration Syntax
public void Close()
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
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.
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
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
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.
Ceate a text.
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.
Create an arrow
Method CreateCircle(double)
Create a cone.
Create a cylinder.
Method CreateDisc(double)
Method CreateGeometry(IGeoEntity)
Method CreateMesh(IElement)
Method CreateMesh(IEnumerable<IElement>)
Method CreateMesh(IMeshData)
Method CreateMesh(IMeshRegion)
Method CreateNodeBox(IEnumerable<INode>)
Method CreateNodeBox(INode)
Method CreateNodeBox(IEnumerable<INode>,
double)
Method CreatePoint()
Method CreatePoint(IEnumerable<IWorldPoint>,
double)
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 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)
Method CreateTriad(double)
CreateArrow(double)
Create an arrow.
Declaration Syntax
public IArrow3D CreateArrow(double length)
Parameters
length(double)
The arrow length.
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
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.
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()
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.
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
Property Scene
Property Unit
Method ForceResume()
Method Redraw()
Method Suspend()
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.
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.
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
Property Factory2D
Property Factory3D
Method Clear()
Method CreateChildCollection()
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)
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
Property Y
Method Set(int,
int)
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
Method Clone()
Method ToPixelPoint()
Method ToWorldPoint()
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
Property Scale
Method Reset()
Method Set(double[])
Method Set(IWorldPoint)
Method ToArray()
Method Translate(IVector3D)
Applies a translation.
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.
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.
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.
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
Property Y
Property Z
Method CrossProduct(IVector3D)
Method GetNormal()
Method IsColinearTo(IVector3D)
Method Length()
Method Normalize()
Method SquareLength()
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
Property ObjectType
Property Parent
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
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 HtmlContentFile
Method NotifyChange()
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
Property CurrentStep
Property Description
Property Folder
Property Name
Property 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
Property PreviousStep
Property StepId
Property SystemName
Property UserInterface
Property 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
INodeBox3D
IPoint3D
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
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
Property Length
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
Property Samples
Gets or sets the number of divisions for the top and the botton circles. The
default value is 16.
Property TopRadius
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
Property DisplayFace
Property FaceColor
Property VertexColor
Property VertexSize
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
Property Is3D
Property LineWeight
Method Delete()
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
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
Property EndPoint
Property Length
Property Points
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
Property Connectivity
Property HasColors
Property Initialized
Property Normals
Property TriangleCount
Property Vertices
Method SetAttributes(IEnumerable<double>,
IEnumerable<double>, IEnumerable<int>)
Method SetAttributes(IEnumerable<double>,
IEnumerable<double>, IEnumerable<int>,
IEnumerable<int>)
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; }
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.
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
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
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
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
IParameter
Defines a selection
information.
ISelectionManager
Defines a selection
manager.
ITools
IAttributeCollection
Defines a collection of attributes.
Declaration Syntax
public interface IAttributeCollection
Table 246: Members
Property Item
Property Keys
Method Contains(string)
Method GetStringValue(string)
Method GetValue(string)
Method GetValue(string, object) Returns the value of the attribute identified by its name.
Method Remove(string)
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)
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
Property UniqueId
Property Version
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
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()
Method WriteError(string)
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
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
Property Ids
Property Name
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
Method AddSelection(ISelectionInfo)
Method ClearSelection()
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 GetResultsDataFromFile(string)
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
Member MeshNodes
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
IDataObject
IDataObjectCollection
IDataObjectContainer
ISolverData
SolveTypeEnum
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
Property Components
Property CoordinateSystems
Property GeoData
Property Id
Property LoadObjects
Property MeshData
Property Name
Property PhysicsType
Property PropertyNames
Property ResultObjects
Property Solver
Property SolverName
Property StepsEndTime
Property UserObjects
Property WorkingDir
Method ComponentById(int)
Method CoordinateSystemById(int)
Method CreateLoadObject(string)
Method CreatePostObject(string)
Method CreateResultObject(string)
Method GetResultsData()
Method PropertyValue(string)
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)
Method WriteInputFile(string)
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
Property Matrix
Property Name
Property Origin
Property XAxis
Property YAxis
Property ZAxis
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
Property Name
Property PropertyNames
Property Type
Method PropertyValue(string)
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
Property List
Property Names
Method GetById(int)
Method GetByName(string)
Method GetEnumerator()
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
371
Ansys.ACT.Interfaces.Analysis Namespace
Property MaxElementId
Property MaxElementType
Property MaxNodeId
Property SolveType
Method GetContactId(int)
Method GetContactTargetId(int)
Method GetNewElementId()
Method GetNewElementType()
Method GetNewNodeId()
Method GetRemotePointNodeId(int)
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
Member Electric
Member EMag
Member Harmonic
Member Modal
Member MPRS
Member MPRSAcceleration
Member MPRSVelocity
Member MSUPChartExpansion
Member MSUPExpansion
Member MSUPHarmonic
Member MSUPHarmonicAccelerationX
Member MSUPHarmonicAccelerationY
Member MSUPHarmonicAccelerationZ
Member MSUPHarmonicBearingLoad
Member MSUPHarmonicForceSurfaceX
Member MSUPHarmonicForceSurfaceXImaginary
Member MSUPHarmonicForceSurfaceY
Member MSUPHarmonicForceSurfaceYImaginary
Member MSUPHarmonicForceSurfaceZ
Member MSUPHarmonicForceSurfaceZImaginary
Member MSUPHarmonicPreStressed
Member MSUPHarmonicRemoteLoadX
Member MSUPHarmonicRemoteLoadXImaginary
Member MSUPHarmonicRemoteLoadY
Member MSUPHarmonicRemoteLoadYImaginary
Member MSUPHarmonicRemoteLoadZ
Member MSUPHarmonicRemoteLoadZImaginary
Member MSUPHarmonicSFBasedLoad
Member MSUPHarmonicSFBasedLoadImaginary
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 MSUPHarmonicVertexFollowElement
Member MSUPHarmonicVertexFollowElementImaginary
MSUPHarmonicVertexFollowElementImaginary solve
type.
Member MSUPTransient
Member Spectral
Member SPRS
Member SPRSAcceleration
Member SPRSVelocity
Member Structural
Member Thermal
Member ThermoElectric
Member Unknown
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()
Constructor Matrix4D(double[])
Constructor Matrix4D(Matrix4D)
Copy constructor
Field
Identity
Property
Determinant
Property
Item
Property
Item
Method
Add(Matrix4D)
Method
CreateMirror(Vector3D, double)
Method
CreateRotate(Vector3D, double)
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)
Method
CreateSystem(Vector3D, Vector3D,
Vector3D)
Method
CreateTranslate(double, double,
double)
Method
Invert()
Method
Multiply(Matrix4D)
Method
Method
Subtract(Matrix4D)
Method
ToString()
String representation.
Method
Transform(Vector3D)
Method
Method
Transpose()
Transpose itself.
operator
op_Addition(Matrix4D, Matrix4D)
operator
op_Explicit(Matrix4D)
operator
op_Multiply(Matrix4D, Matrix4D)
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.
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.
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.
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.
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.
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[])
Constructor Vector3D(Vector3D)
Copy constructor
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
Property
Item
Indexer
Property
Magnitude
Property
MagnitudeSquared
Method
Add(Vector3D)
Method
CloneNormalized()
Method
Cross(Vector3D, Vector3D)
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)
Method
Method
GetHashCode()
Object.GetHashCode() override
Method
Normalize()
Method
Subtract(Vector3D)
Method
ToString()
String representation.
operator
op_Addition(Vector3D, Vector3D)
Plus operator
operator
op_Division(Vector3D, double)
operator
op_Equality(Vector3D, Vector3D)
Equal operator
operator
op_Explicit(Vector3D)
operator
op_Inequality(Vector3D, Vector3D)
Not-Equal operator
operator
op_Multiply(double, Vector3D)
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)
operator
op_Multiply(Vector3D, Vector3D)
operator
op_Subtraction(Vector3D, Vector3D)
Minus operator
operator
op_UnaryNegation(Vector3D)
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.
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
IMeshData
IMeshRegion
INode
ElementTypeEnum
Specifies the element type.
Declaration Syntax
public enum ElementTypeEnum
Table 268: Members
Member kBeam3
Member kBeam4
Member kHex20
Twenty Node
Hexahedron.
Member kHex8
Eight Node
Hexahedron.
Member kLine2
Member kLine3
Member kPoint0
Point.
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
Member kTri6
IElement
Defines a mesh element.
Declaration Syntax
public interface IElement
Table 269: Members
Property Area
Property Centroid
Property CornerNodes
Property Dimension
Property Id
Property NodeIds
Property Nodes
Property Type
Property Volume
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
Property ElementIds
Property Elements
Property NodeCount
Property NodeIds
Property Nodes
Property Unit
Property UseCache
Method ElementById(int)
Method NodeById(int)
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
Property Elements
Property NodeCount
Property NodeIds
Property Nodes
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
Property ConnectedElementIds Gets the list of the element ids connected to the node.
Property ConnectedElements
Property GeoEntityIds
Property Id
Property X
Property Y
Property Z
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
enumParameterRelationshipType
enumPointState
enumSimulationType
IMethod
IPoint
IServices
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)
Method AddOutput(string)
Method get_Setting(string)
Method Run()
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.
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.
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.
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
Property State
Property StateMessage
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)
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
Property Stopped
Method CalculateParameterRelationshipsFromPoint(IPoint)
Method CalculatePoints(IListCpp)
Method PublishLogMessage(string)
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)
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
MaximumNumberOfDoubleParameters attribute
of the sampling. Indicates the maximum number
of double parameters supported.
Property MaximumNumberOfInputParameters
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
Property NumberOfDoubleParametersDefined
Property NumberOfInputParametersDefined
Property NumberOfIntegerListParametersDefined
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.
enumCurveType
enumGoalType
enumPostProcessingType
IConvergenceData
IConvergenceDescription
IOptimizationMethod
IOptimizationPoint
IOptimizationServices
IUserOptimizer
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)
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
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
Property NumberOfFeasibleCurves
Property NumberOfGroups
Property Quantity
Property Unit
Property XAxisLabel
Property YAxisLabel
Adds a curve.
Method AddGroup(string)
Method get_CurveLabel(int)
Method get_CurveType(int)
Method get_GroupLabel(int)
Method get_NumberOfCurves(int)
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; }
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
425
Ansys.DesignXplorer.API.Optimization Namespace
Property PostProcessingTypes
Property Samples
Property Services
Method AddConstraint(string,
enumConstraintType, object, object,
double, bool)
Method AddDoubleListVariable(string,
IListCpp, double)
Method AddIntegerListVariable(string,
IListCpp, int)
Method AddParameterRelationship(string,
string, string,
enumParameterRelationshipType)
Method get_Setting(string)
Method Run()
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; }
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.
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.
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.
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.
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.
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.
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.
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
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
Property ID
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
Property StateMessage
Method get_Value(string)
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
Property Stopped
Method CalculateParameterRelationshipsFromPoint(IPoint)
434
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)
Method PublishLogMessage(string)
Method PushConvergenceData(IConvergenceData)
Method PushHistoryPoint(IOptimizationPoint)
Method PushHistoryPoints(IListCpp)
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
Property BasedOnResponseSurfaceOnly
Property ConstraintHandling
Property ConstraintImportance
Property ConstraintOnInputParameter
Property ConvergenceData
Property EqualToConstraint
Property EqualToConstraintDefined
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
Property GreaterThanConstraintDefined
Property HistoryChartXAxisType
Property InsideBoundsConstraint
Property InsideBoundsConstraintDefined
Property IsDirectOptimization
Property LessThanConstraint
Property LessThanConstraintDefined
Property LogFile
Property MaximizeObjective
Property MaximizeObjectiveDefined
Property MaximumNumberOfConstraints
Value of the
MaximumNumberOfDoubleParameters attribute
of the optimizer. Indicates the maximum number
of double parameters supported.
Property MaximumNumberOfInputParameters
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
Property MinimizeObjective
Property MinimizeObjectiveDefined
Property MinimumNumberOfConstraints
Property MinimumNumberOfObjectives
Property NumberOfConstraintsDefined
Property NumberOfConstraintsDefinedOnInputs
Property NumberOfDoubleListParametersDefined
Property NumberOfDoubleParametersDefined
Property NumberOfInputParametersDefined
Property NumberOfIntegerListParametersDefined
Property NumberOfObjectivesDefined
Property NumberOfObjectivesDefinedOnInputs
Property ObjectiveImportance
Property ObjectiveOnInputParameter
Property ParameterRelationship
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
Property SeekObjectiveDefined
Property StartingPointRequired
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
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.