EMTransducer
Last update: 14.01.2025
EMTransducer
class Ansys.ACT.Automation.Mechanical.BoundaryConditions.EMTransducer
Bases: object
Defines a EMTransducer.
Overview
Methods
Name | Description |
---|---|
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. |
GetActivateAtLoadStep |
Gets whether the EM transducer is active at the specified load step. |
GetChildren |
Gets the list of children, filtered by type. |
GetComponentActivateAtLoadStep |
GetComponentActivateAtLoadStep method. |
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. |
SetActivateAtLoadStep |
Sets whether the EM transducer is active at the specified load step. |
SetComponentActivateAtLoadStep |
SetComponentActivateAtLoadStep method. |
Properties
Name | Description |
---|---|
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
CoordinateSystem |
Gets the CoordinateSystem. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Figures |
Gets the list of associated figures. |
GAPDirection |
Gets or sets the GAPDirection. |
Images |
Gets the list of associated images. |
IndependentVariable |
Gets or sets the IndependentVariable. |
InitialGap |
Gets or sets the InitialGap. |
InternalObject |
Gets the internal object. For advanced usage only. |
Location |
Gets or sets the Location. |
MinimalGap |
Gets or sets the MinimalGap. |
NumberOfSegments |
Gets or sets the NumberOfSegments. |
Properties |
Gets the list of properties for this object. |
ReadOnly |
Gets or sets the ReadOnly. |
SharedRefBody |
Gets or sets the SharedRefBody. |
StiffnessMethod |
Gets or sets the StiffnessMethod. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
VoltageDifference |
Gets the VoltageDifference. |
ZCoordinate |
Gets or sets the ZCoordinate. |
Property detail
property EMTransducer.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property EMTransducer.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property EMTransducer.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets the CoordinateSystem.
property EMTransducer.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property EMTransducer.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property EMTransducer.GAPDirection : Ansys.Mechanical.DataModel.Enums.GAPDirectionType | None
Gets or sets the GAPDirection.
property EMTransducer.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property EMTransducer.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None
Gets or sets the IndependentVariable.
property EMTransducer.InitialGap : Ansys.Core.Units.Quantity | None
Gets or sets the InitialGap.
property EMTransducer.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None
Gets the internal object. For advanced usage only.
property EMTransducer.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property EMTransducer.MinimalGap : Ansys.Core.Units.Quantity | None
Gets or sets the MinimalGap.
property EMTransducer.NumberOfSegments : int | None
Gets or sets the NumberOfSegments.
property EMTransducer.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property EMTransducer.ReadOnly : bool | None
Gets or sets the ReadOnly.
property EMTransducer.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None
Gets or sets the SharedRefBody.
property EMTransducer.StiffnessMethod : Ansys.Mechanical.DataModel.Enums.StiffnessMethodType | None
Gets or sets the StiffnessMethod.
property EMTransducer.Suppressed : bool | None
Gets or sets the Suppressed.
property EMTransducer.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
property EMTransducer.VoltageDifference : Ansys.ACT.Mechanical.Fields.Field | None
Gets the VoltageDifference.
property EMTransducer.ZCoordinate : Ansys.Core.Units.Quantity | None
Gets or sets the ZCoordinate.
Method detail
EMTransducer.Activate()
Activate the current object.
EMTransducer.AddComment()
Creates a new child Comment.
EMTransducer.AddFigure()
Creates a new child Figure.
EMTransducer.AddImage(filePath: str)
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.
EMTransducer.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
EMTransducer.CreateParameter(propName: str)
Creates a new parameter for a Property.
EMTransducer.Delete()
Run the Delete action.
EMTransducer.Duplicate()
Creates a copy of the current DataModelObject.
EMTransducer.GetActivateAtLoadStep(stepNumber: int)
Gets whether the EM transducer is active at the specified load step.
EMTransducer.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
EMTransducer.GetComponentActivateAtLoadStep(component: str, stepNumber: int)
GetComponentActivateAtLoadStep method.
EMTransducer.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
EMTransducer.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
EMTransducer.GroupSimilarObjects()
Run the GroupSimilarObjects action.
EMTransducer.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
EMTransducer.PropertyByAPIName(name: str)
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.
EMTransducer.PropertyByName(name: str)
Get a property by its unique name.
EMTransducer.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
EMTransducer.SetActivateAtLoadStep(stepNumber: int, bActive: bool)
Sets whether the EM transducer is active at the specified load step.
EMTransducer.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)
SetComponentActivateAtLoadStep method.