Skip to main content

Mechanical scripting interface

ElectricFieldProbe

Last update: 14.01.2025

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

Bases: object

Defines a ElectricFieldProbe.

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’.
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.
Figures Gets the list of associated figures.
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.
MaximumTotal Gets the MaximumTotal.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
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.
ResultSelection Gets or sets the ResultSelection.
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.
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.
YAxisFieldIntensity Gets the YAxisFieldIntensity.
ZAxis Gets the ZAxis.
ZAxisFieldIntensity Gets the ZAxisFieldIntensity.

Property detail

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

Gets or sets the BeamSelection.

property ElectricFieldProbe.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 ElectricFieldProbe.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property ElectricFieldProbe.IsSolved : bool | None

Gets the IsSolved.

property ElectricFieldProbe.IterationNumber : int | None

Gets the IterationNumber.

property ElectricFieldProbe.LoadStep : int | None

Gets the LoadStep.

property ElectricFieldProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

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

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

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

Gets the list of properties for this object.

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

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

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

Gets or sets the RemotePointSelection.

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

Gets or sets the ResultSelection.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property ElectricFieldProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property ElectricFieldProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

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

Gets the Total.

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

Gets the Type.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

property ElectricFieldProbe.YAxisFieldIntensity : Ansys.Core.Units.Quantity | None

Gets the YAxisFieldIntensity.

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

Gets the ZAxis.

property ElectricFieldProbe.ZAxisFieldIntensity : Ansys.Core.Units.Quantity | None

Gets the ZAxisFieldIntensity.

Method detail

ElectricFieldProbe.Activate()

Activate the current object.

ElectricFieldProbe.AddComment()

Creates a new child Comment.

ElectricFieldProbe.AddFigure()

Creates a new child Figure.

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

ElectricFieldProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ElectricFieldProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

ElectricFieldProbe.Delete()

Run the Delete action.

ElectricFieldProbe.Duplicate()

Creates a copy of the current DataModelObject.

ElectricFieldProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

ElectricFieldProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

ElectricFieldProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ElectricFieldProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ElectricFieldProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ElectricFieldProbe.PropertyByName(name: str)

Get a property by its unique name.

ElectricFieldProbe.RemoveParameter(propName: str)

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

ElectricFieldProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

ElectricFieldProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.