SubstructureGenerationCondensedPart#

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.SubstructureGenerationCondensedPart(internalObject: Any)#

Bases: object

Defines a SubstructureGenerationCondensedPart.

Overview#

Activate

Activate the current object.

AddCommandSnippet

Creates a new CommandSnippet

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

ClearGeneratedData

Run the ClearGeneratedData action.

CopyTo

Copies all visible properties from this object to another.

CreateObjRef

CreateObjRef method.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

Equals

Equals method.

GetAPIName

Property name bound to dispId.

GetAllProperties

GetAllProperties method.

GetChildren

Gets the list of children, filtered by type.

GetDetailsView

GetDetailsView method.

GetEnumName

Enum name bound to value

GetHashCode

GetHashCode method.

GetIconFile

GetIconFile method.

GetLifetimeService

GetLifetimeService method.

GetObjectData

GetObjectData method.

GetParameter

Gets the parameter corresponding to the given property.

GetPath

GetPath method.

GetPropertyName

GetPropertyName method.

GetPropertyValue

GetPropertyValue method.

GetType

GetType method.

GetVisibleProperties

GetVisibleProperties method.

GetVisiblePropertyNames

GetVisiblePropertyNames method.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

InitializeLifetimeService

InitializeLifetimeService method.

IsPropertyEditable

IsPropertyEditable method.

IsPropertyVisible

IsPropertyVisible method.

PropertyByAPIName

Get a property by its API name.

PropertyById

PropertyById method.

PropertyByName

Get a property by its unique name.

RemoveParameter

Removes the parameter from the parameter set corresponding to the given property.

ToString

ToString method.

AttachedRefs

AttachedRefs property.

AttachmentMethod

Gets or sets the AttachmentMethod.

Children

Gets the list of children.

ClsId

ClsId property.

Comments

Gets the list of associated comments.

DataModelObjectCategory

Gets the current DataModelObject's category.

Figures

Gets the list of associated figures.

FutureExpansion

Gets or sets the Future Expansion property that controls whether to request specific data in the solver files required to perform an expansion pass on the condensed part. Default: ProgramControlled

GenerateDampingMatrix

Gets or sets the GenerateDampingMatrix.

GeometrySelection

Gets or sets the GeometrySelection.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Images

Gets the list of associated images.

InterfaceMethod

Gets or sets the InterfaceMethod.

Interfaces

Returns the Interfaces of the condensed part

InternalObject

Gets the internal object. For advanced usage only.

LumpedMassFormulation

Gets or sets the LumpedMassFormulation.

Name

Name property.

NumberInterfaceEntries

Gets the NumberInterfaceEntries.

NumberMasterNodes

Gets the NumberMasterNodes.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

Parent

Parent property.

Physics

Gets the Physics.

PointMassTreatment

Gets or sets the PointMassTreatment.

Properties

Gets the list of properties for this object.

ReductionMethod

Gets or sets the ReductionMethod.

ReferenceTemperature

Gets or sets the ReferenceTemperature.

SolutionName

Gets or sets the SolutionName.

SolutionNameMode

Gets or sets the SolutionNameMode.

SolverFilesDirectory

Gets the SolverFilesDirectory.

SolverUnitSystem

Gets or sets the SolverUnitSystem.

SolverUnits

Gets or sets the SolverUnits.

State

State property.

Suppressed

Gets or sets the Suppressed.

TemperatureUnits

Gets the TemperatureUnits.

VisibleProperties

Gets the list of properties that are visible for this object.

Property detail#

property SubstructureGenerationCondensedPart.AttachedRefs: List[int] | None#

AttachedRefs property.

property SubstructureGenerationCondensedPart.AttachmentMethod: Ansys.Mechanical.DataModel.Enums.CondensedPartCMSAttachmentMethod | None#

Gets or sets the AttachmentMethod.

property SubstructureGenerationCondensedPart.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property SubstructureGenerationCondensedPart.ClsId: int | None#

ClsId property.

property SubstructureGenerationCondensedPart.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#

Gets the list of associated comments.

property SubstructureGenerationCondensedPart.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property SubstructureGenerationCondensedPart.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#

Gets the list of associated figures.

property SubstructureGenerationCondensedPart.FutureExpansion: Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled | None#

Gets or sets the Future Expansion property that controls whether to request specific data in the solver files required to perform an expansion pass on the condensed part. Default: ProgramControlled

property SubstructureGenerationCondensedPart.GenerateDampingMatrix: Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled | None#

Gets or sets the GenerateDampingMatrix.

property SubstructureGenerationCondensedPart.GeometrySelection: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the GeometrySelection.

property SubstructureGenerationCondensedPart.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

GroupingFolder property.

property SubstructureGenerationCondensedPart.IconName: str | None#

IconName property.

property SubstructureGenerationCondensedPart.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#

Gets the list of associated images.

property SubstructureGenerationCondensedPart.InterfaceMethod: Ansys.Mechanical.DataModel.Enums.CondensedPartInterfaceMethod | None#

Gets or sets the InterfaceMethod.

property SubstructureGenerationCondensedPart.Interfaces: Ansys.ACT.Automation.Mechanical.CondensedPartInterfaces | None#

Returns the Interfaces of the condensed part

property SubstructureGenerationCondensedPart.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCondensedPartAuto | None#

Gets the internal object. For advanced usage only.

property SubstructureGenerationCondensedPart.LumpedMassFormulation: Ansys.Mechanical.DataModel.Enums.CondensedPartLumpedMassFormulation | None#

Gets or sets the LumpedMassFormulation.

property SubstructureGenerationCondensedPart.Name: str | None#

Name property.

property SubstructureGenerationCondensedPart.NumberInterfaceEntries: int | None#

Gets the NumberInterfaceEntries.

property SubstructureGenerationCondensedPart.NumberMasterNodes: int | None#

Gets the NumberMasterNodes.

property SubstructureGenerationCondensedPart.ObjectId: int | None#

ObjectId property.

property SubstructureGenerationCondensedPart.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#

ObjectState property.

property SubstructureGenerationCondensedPart.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#

ObjectTags property.

property SubstructureGenerationCondensedPart.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

Parent property.

property SubstructureGenerationCondensedPart.Physics: Ansys.Mechanical.DataModel.Enums.CondensedPartPhysics | None#

Gets the Physics.

property SubstructureGenerationCondensedPart.PointMassTreatment: Ansys.Mechanical.DataModel.Enums.CondensedPartPointMassTreatment | None#

Gets or sets the PointMassTreatment.

property SubstructureGenerationCondensedPart.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property SubstructureGenerationCondensedPart.ReductionMethod: Ansys.Mechanical.DataModel.Enums.CondensedPartReductionMethod | None#

Gets or sets the ReductionMethod.

property SubstructureGenerationCondensedPart.ReferenceTemperature: Ansys.Core.Units.Quantity | None#

Gets or sets the ReferenceTemperature.

property SubstructureGenerationCondensedPart.SolutionName: str | None#

Gets or sets the SolutionName.

property SubstructureGenerationCondensedPart.SolutionNameMode: Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None#

Gets or sets the SolutionNameMode.

property SubstructureGenerationCondensedPart.SolverFilesDirectory: str | None#

Gets the SolverFilesDirectory.

property SubstructureGenerationCondensedPart.SolverUnitSystem: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None#

Gets or sets the SolverUnitSystem.

property SubstructureGenerationCondensedPart.SolverUnits: Ansys.Mechanical.DataModel.Enums.SolverUnitsControlType | None#

Gets or sets the SolverUnits.

property SubstructureGenerationCondensedPart.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#

State property.

property SubstructureGenerationCondensedPart.Suppressed: bool | None#

Gets or sets the Suppressed.

property SubstructureGenerationCondensedPart.TemperatureUnits: str | None#

Gets the TemperatureUnits.

property SubstructureGenerationCondensedPart.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties that are visible for this object.

Method detail#

SubstructureGenerationCondensedPart.Activate() None#

Activate the current object.

SubstructureGenerationCondensedPart.AddCommandSnippet() Ansys.ACT.Automation.Mechanical.CommandSnippet#

Creates a new CommandSnippet

SubstructureGenerationCondensedPart.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

SubstructureGenerationCondensedPart.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

SubstructureGenerationCondensedPart.AddImage(filePath: str) Ansys.ACT.Automation.Mechanical.Image#
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.
SubstructureGenerationCondensedPart.ClearGeneratedData() None#

Run the ClearGeneratedData action.

SubstructureGenerationCondensedPart.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

SubstructureGenerationCondensedPart.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

SubstructureGenerationCondensedPart.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

SubstructureGenerationCondensedPart.Delete() None#

Run the Delete action.

SubstructureGenerationCondensedPart.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

SubstructureGenerationCondensedPart.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

SubstructureGenerationCondensedPart.GetAPIName(dispId: int) str#

Property name bound to dispId.

SubstructureGenerationCondensedPart.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

SubstructureGenerationCondensedPart.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

SubstructureGenerationCondensedPart.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

SubstructureGenerationCondensedPart.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

SubstructureGenerationCondensedPart.GetHashCode() int#

GetHashCode method.

SubstructureGenerationCondensedPart.GetIconFile() System.Byte#

GetIconFile method.

SubstructureGenerationCondensedPart.GetLifetimeService() Any#

GetLifetimeService method.

SubstructureGenerationCondensedPart.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

SubstructureGenerationCondensedPart.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

SubstructureGenerationCondensedPart.GetPath() str#

GetPath method.

SubstructureGenerationCondensedPart.GetPropertyName(dispId: int) str#

GetPropertyName method.

SubstructureGenerationCondensedPart.GetPropertyValue(name: str) Any#

GetPropertyValue method.

SubstructureGenerationCondensedPart.GetType() type#

GetType method.

SubstructureGenerationCondensedPart.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

SubstructureGenerationCondensedPart.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

SubstructureGenerationCondensedPart.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

SubstructureGenerationCondensedPart.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

SubstructureGenerationCondensedPart.InitializeLifetimeService() Any#

InitializeLifetimeService method.

SubstructureGenerationCondensedPart.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

SubstructureGenerationCondensedPart.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

SubstructureGenerationCondensedPart.PropertyByAPIName(name: str) Ansys.ACT.Automation.Mechanical.Property#
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.
SubstructureGenerationCondensedPart.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

SubstructureGenerationCondensedPart.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

SubstructureGenerationCondensedPart.RemoveParameter(propName: str) None#

Removes the parameter from the parameter set corresponding to the given property.

SubstructureGenerationCondensedPart.ToString() str#

ToString method.