BodyControl#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.BodyControl#

Bases: object

Defines a BodyControl.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

CopyTo

Copies all visible properties from this object to another.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

GetChildren

Gets the list of children, filtered by type.

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PromoteToNamedSelection

Run the PromoteToNamedSelection action.

PropertyByAPIName

Get a property by its API name.

PropertyByName

Get a property by its unique name.

RemoveParameter

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

ArtificialViscosityForShells

Gets or sets the ArtificialViscosityForShells.

BeamSolutionType

Gets or sets the BeamSolutionType.

BeamTimeStepSafetyFactor

Gets or sets the BeamTimeStepSafetyFactor.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

DataModelObjectCategory

Gets the current DataModelObject's category.

Figures

Gets the list of associated figures.

HexIntegrationType

Gets or sets the HexIntegrationType.

HourglassDampingType

Gets or sets the HourglassDampingType.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

Properties

Gets the list of properties for this object.

PusoStabilityCoefficient

Gets or sets the PusoStabilityCoefficient.

ReadOnly

Gets or sets the ReadOnly.

SharedRefBody

Gets or sets the SharedRefBody.

ShellBWCWarpCorrection

Gets or sets the ShellBWCWarpCorrection.

ShellInertiaUpdate

Gets or sets the ShellInertiaUpdate.

ShellShearCorrectionFactor

Gets or sets the ShellShearCorrectionFactor.

ShellSublayers

Gets or sets the ShellSublayers.

ShellThicknessUpdate

Gets or sets the ShellThicknessUpdate.

StiffnessCoefficient

Gets or sets the StiffnessCoefficient.

Suppressed

Gets or sets the Suppressed.

TetIntegrationType

Gets or sets the TetIntegrationType.

ViscousCoefficient

Gets or sets the ViscousCoefficient.

VisibleProperties

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

Property detail#

property BodyControl.ArtificialViscosityForShells: bool | None#

Gets or sets the ArtificialViscosityForShells.

property BodyControl.BeamSolutionType: Ansys.Mechanical.DataModel.Enums.BeamSolutionType | None#

Gets or sets the BeamSolutionType.

property BodyControl.BeamTimeStepSafetyFactor: float | None#

Gets or sets the BeamTimeStepSafetyFactor.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property BodyControl.HexIntegrationType: Ansys.Mechanical.DataModel.Enums.HexIntegrationType | None#

Gets or sets the HexIntegrationType.

property BodyControl.HourglassDampingType: Ansys.Mechanical.DataModel.Enums.HourglassDampingType | None#

Gets or sets the HourglassDampingType.

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

Gets the list of associated images.

property BodyControl.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#

Gets the internal object. For advanced usage only.

property BodyControl.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

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

Gets the list of properties for this object.

property BodyControl.PusoStabilityCoefficient: float | None#

Gets or sets the PusoStabilityCoefficient.

property BodyControl.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property BodyControl.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None#

Gets or sets the SharedRefBody.

property BodyControl.ShellBWCWarpCorrection: bool | None#

Gets or sets the ShellBWCWarpCorrection.

property BodyControl.ShellInertiaUpdate: Ansys.Mechanical.DataModel.Enums.ShellInertiaUpdate | None#

Gets or sets the ShellInertiaUpdate.

property BodyControl.ShellShearCorrectionFactor: float | None#

Gets or sets the ShellShearCorrectionFactor.

property BodyControl.ShellSublayers: int | None#

Gets or sets the ShellSublayers.

property BodyControl.ShellThicknessUpdate: Ansys.Mechanical.DataModel.Enums.ShellThicknessUpdate | None#

Gets or sets the ShellThicknessUpdate.

property BodyControl.StiffnessCoefficient: float | None#

Gets or sets the StiffnessCoefficient.

property BodyControl.Suppressed: bool | None#

Gets or sets the Suppressed.

property BodyControl.TetIntegrationType: Ansys.Mechanical.DataModel.Enums.TetIntegrationType | None#

Gets or sets the TetIntegrationType.

property BodyControl.ViscousCoefficient: float | None#

Gets or sets the ViscousCoefficient.

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

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

Method detail#

BodyControl.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

BodyControl.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.
BodyControl.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

BodyControl.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

BodyControl.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

BodyControl.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

BodyControl.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.
BodyControl.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

BodyControl.RemoveParameter(propName: str) None#

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