Skip to main content

Mechanical scripting interface

ElectromechanicalCouplingCoefficient

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ElectromechanicalCouplingCoefficient

Bases: object

Defines a ElectromechanicalCouplingCoefficient.

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.
ClearGeneratedData Run the ClearGeneratedData action.
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.
DuplicateWithoutResults Run the DuplicateWithoutResults action.
EvaluateAllResults Run the EvaluateAllResults action.
ExportAnimation Run the ExportAnimation action.
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.
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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.
SnapToMeshNodes Snap the coordinates of probe result to the mesh nodes.

Properties

Name Description
BeamSelection Gets or sets the BeamSelection.
BoundaryConditionSelection Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.
By Gets or sets the By.
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactRegionSelection Gets or sets the ContactRegionSelection.
CoordinateSystemSelection Gets or sets the CoordinateSystemSelection.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayTime Gets or sets the DisplayTime.
DpfEvaluation Gets or sets the DpfEvaluation.
ElectromechanicalCouplingCoefficientValue Gets the ElectromechanicalCouplingCoefficientValue.
Figures Gets the list of associated figures.
Frequency Gets or sets the Frequency.
GeometryLocation Gets or sets the GeometryLocation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsSolved Gets the IsSolved.
IterationNumber Gets the IterationNumber.
LoadStep Gets the LoadStep.
LoadStepNumber Gets or sets the LoadStepNumber.
LocationMethod Gets or sets the LocationMethod.
MaximumElectromechanicalCouplingCoefficient Gets the MaximumElectromechanicalCouplingCoefficient.
MaximumTotal Gets the MaximumTotal.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumElectromechanicalCouplingCoefficient Gets the MinimumElectromechanicalCouplingCoefficient.
MinimumTotal Gets the MinimumTotal.
MinimumXAxis Gets the MinimumXAxis.
MinimumYAxis Gets the MinimumYAxis.
MinimumZAxis Gets the MinimumZAxis.
Orientation Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
Properties Gets the list of properties for this object.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
RemotePointSelection Gets or sets the RemotePointSelection.
ReportedFrequency Gets the ReportedFrequency.
ResultSelection Gets or sets the ResultSelection.
SetNumber Gets or sets the SetNumber.
SpatialResolution Gets or sets the SpatialResolution.
SpringSelection Gets or sets the SpringSelection.
Substep Gets the Substep.
Summation Gets or sets the Summation.
Suppressed Gets or sets the Suppressed.
SurfaceSelection Gets or sets the MeshConnectionSelection.
SweepingPhase Gets or sets the SweepingPhase.
Time Gets the Time.
Total Gets the Total.
Type Gets the Type.
VisibleProperties Gets the list of properties that are visible for this object.
XAxis Gets the XAxis.
YAxis Gets the YAxis.
ZAxis Gets the ZAxis.

Property detail

property ElectromechanicalCouplingCoefficient.BeamSelection : Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the BeamSelection.

property ElectromechanicalCouplingCoefficient.BoundaryConditionSelection : Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.

property ElectromechanicalCouplingCoefficient.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

property ElectromechanicalCouplingCoefficient.ContactRegionSelection : Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

property ElectromechanicalCouplingCoefficient.CoordinateSystemSelection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystemSelection.

property ElectromechanicalCouplingCoefficient.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property ElectromechanicalCouplingCoefficient.DisplayTime : Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property ElectromechanicalCouplingCoefficient.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

property ElectromechanicalCouplingCoefficient.ElectromechanicalCouplingCoefficientValue : float | None

Gets the ElectromechanicalCouplingCoefficientValue.

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

Gets the list of associated figures.

property ElectromechanicalCouplingCoefficient.Frequency : Ansys.Core.Units.Quantity | None

Gets or sets the Frequency.

property ElectromechanicalCouplingCoefficient.GeometryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property ElectromechanicalCouplingCoefficient.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property ElectromechanicalCouplingCoefficient.IsSolved : bool | None

Gets the IsSolved.

property ElectromechanicalCouplingCoefficient.IterationNumber : int | None

Gets the IterationNumber.

property ElectromechanicalCouplingCoefficient.LoadStep : int | None

Gets the LoadStep.

property ElectromechanicalCouplingCoefficient.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

property ElectromechanicalCouplingCoefficient.LocationMethod : Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property ElectromechanicalCouplingCoefficient.MaximumElectromechanicalCouplingCoefficient : float | None

Gets the MaximumElectromechanicalCouplingCoefficient.

property ElectromechanicalCouplingCoefficient.MaximumTotal : Ansys.Core.Units.Quantity | None

Gets the MaximumTotal.

property ElectromechanicalCouplingCoefficient.MaximumXAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumXAxis.

property ElectromechanicalCouplingCoefficient.MaximumYAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumYAxis.

property ElectromechanicalCouplingCoefficient.MaximumZAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumZAxis.

property ElectromechanicalCouplingCoefficient.MeshConnectionSelection : Ansys.ACT.Automation.Mechanical.MeshConnection | None

Gets or sets the MeshConnectionSelection.

property ElectromechanicalCouplingCoefficient.MinimumElectromechanicalCouplingCoefficient : float | None

Gets the MinimumElectromechanicalCouplingCoefficient.

property ElectromechanicalCouplingCoefficient.MinimumTotal : Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

property ElectromechanicalCouplingCoefficient.MinimumXAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumXAxis.

property ElectromechanicalCouplingCoefficient.MinimumYAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumYAxis.

property ElectromechanicalCouplingCoefficient.MinimumZAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumZAxis.

property ElectromechanicalCouplingCoefficient.Orientation : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

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

Gets the list of properties for this object.

property ElectromechanicalCouplingCoefficient.RPMSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

property ElectromechanicalCouplingCoefficient.RemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property ElectromechanicalCouplingCoefficient.ReportedFrequency : Ansys.Core.Units.Quantity | None

Gets the ReportedFrequency.

property ElectromechanicalCouplingCoefficient.ResultSelection : Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None

Gets or sets the ResultSelection.

property ElectromechanicalCouplingCoefficient.SetNumber : int | None

Gets or sets the SetNumber.

property ElectromechanicalCouplingCoefficient.SpatialResolution : Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None

Gets or sets the SpatialResolution.

property ElectromechanicalCouplingCoefficient.SpringSelection : Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the SpringSelection.

property ElectromechanicalCouplingCoefficient.Substep : int | None

Gets the Substep.

property ElectromechanicalCouplingCoefficient.Summation : Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None

Gets or sets the Summation.

property ElectromechanicalCouplingCoefficient.Suppressed : bool | None

Gets or sets the Suppressed.

property ElectromechanicalCouplingCoefficient.SurfaceSelection : Ansys.ACT.Automation.Mechanical.Surface | None

Gets or sets the MeshConnectionSelection.

property ElectromechanicalCouplingCoefficient.SweepingPhase : Ansys.Core.Units.Quantity | None

Gets or sets the SweepingPhase.

property ElectromechanicalCouplingCoefficient.Time : Ansys.Core.Units.Quantity | None

Gets the Time.

property ElectromechanicalCouplingCoefficient.Total : Ansys.Core.Units.Quantity | None

Gets the Total.

property ElectromechanicalCouplingCoefficient.Type : Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

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

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

property ElectromechanicalCouplingCoefficient.XAxis : Ansys.Core.Units.Quantity | None

Gets the XAxis.

property ElectromechanicalCouplingCoefficient.YAxis : Ansys.Core.Units.Quantity | None

Gets the YAxis.

property ElectromechanicalCouplingCoefficient.ZAxis : Ansys.Core.Units.Quantity | None

Gets the ZAxis.

Method detail

ElectromechanicalCouplingCoefficient.Activate()

Activate the current object.

ElectromechanicalCouplingCoefficient.AddComment()

Creates a new child Comment.

ElectromechanicalCouplingCoefficient.AddFigure()

Creates a new child Figure.

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

ElectromechanicalCouplingCoefficient.ClearGeneratedData()

Run the ClearGeneratedData action.

ElectromechanicalCouplingCoefficient.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ElectromechanicalCouplingCoefficient.CreateParameter(propName: str)

Creates a new parameter for a Property.

ElectromechanicalCouplingCoefficient.Delete()

Run the Delete action.

ElectromechanicalCouplingCoefficient.Duplicate()

Creates a copy of the current DataModelObject.

ElectromechanicalCouplingCoefficient.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

ElectromechanicalCouplingCoefficient.EvaluateAllResults()

Run the EvaluateAllResults action.

ElectromechanicalCouplingCoefficient.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings)

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

ElectromechanicalCouplingCoefficient.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ElectromechanicalCouplingCoefficient.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ElectromechanicalCouplingCoefficient.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ElectromechanicalCouplingCoefficient.PropertyByName(name: str)

Get a property by its unique name.

ElectromechanicalCouplingCoefficient.RemoveParameter(propName: str)

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

ElectromechanicalCouplingCoefficient.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

ElectromechanicalCouplingCoefficient.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.