## On this page

  

 

 # `MagneticPotential`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Results.MagneticPotential"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Results.MagneticPotential

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a MagneticPotential.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#MagneticPotential.Activate)Activate the current object.[`AddAlert`](#MagneticPotential.AddAlert)Creates a new Alert[`AddComment`](#MagneticPotential.AddComment)Creates a new child Comment.[`AddConvergence`](#MagneticPotential.AddConvergence)Creates a new Convergence[`AddFigure`](#MagneticPotential.AddFigure)Creates a new child Figure.[`AddImage`](#MagneticPotential.AddImage)Creates a new child Image.[`ClearGeneratedData`](#MagneticPotential.ClearGeneratedData)Run the ClearGeneratedData action.[`CopyTo`](#MagneticPotential.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#MagneticPotential.CreateParameter)CreateParameter method.[`CreateResultsAtAllSets`](#MagneticPotential.CreateResultsAtAllSets)Creates results at all sets for results under a solution.[`Delete`](#MagneticPotential.Delete)Run the Delete action.[`Duplicate`](#MagneticPotential.Duplicate)Creates a copy of the current DataModelObject.[`DuplicateWithoutResults`](#MagneticPotential.DuplicateWithoutResults)Run the DuplicateWithoutResults action.[`EvaluateAllResults`](#MagneticPotential.EvaluateAllResults)Run the EvaluateAllResults action.[`ExportAnimation`](#MagneticPotential.ExportAnimation)Run the ExportAnimation action.[`ExportToTextFile`](#MagneticPotential.ExportToTextFile)Run the ExportToTextFile action.[`FetchRemoteResults`](#MagneticPotential.FetchRemoteResults)Run the FetchRemoteResult action.[`GetChildren`](#MagneticPotential.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#MagneticPotential.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#MagneticPotential.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#MagneticPotential.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PromoteToNamedSelection`](#MagneticPotential.PromoteToNamedSelection)Run the PromoteToNamedSelection action.[`PropertyByAPIName`](#MagneticPotential.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#MagneticPotential.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#MagneticPotential.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`RenameBasedOnDefinition`](#MagneticPotential.RenameBasedOnDefinition)Run the RenameBasedOnDefinition action.### Properties

NameDescription[`Average`](#MagneticPotential.Average)Gets the Average.[`By`](#MagneticPotential.By)Gets or sets the By.[`CalculateTimeHistory`](#MagneticPotential.CalculateTimeHistory)Gets or sets the CalculateTimeHistory.[`Children`](#MagneticPotential.Children)Gets the list of children.[`CombinationNumber`](#MagneticPotential.CombinationNumber)Gets or sets the Combination Number for a Solution Combination result.[`Comments`](#MagneticPotential.Comments)Gets the list of associated comments.[`CoordinateSystem`](#MagneticPotential.CoordinateSystem)Gets or sets the Coordinate System.[`CrackFrontNumber`](#MagneticPotential.CrackFrontNumber)Gets or sets the CrackFrontNumber.[`DataModelObjectCategory`](#MagneticPotential.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DisplayOption`](#MagneticPotential.DisplayOption)Gets or sets the DisplayOption.[`DisplayTime`](#MagneticPotential.DisplayTime)Gets or sets the DisplayTime.[`DpfEvaluation`](#MagneticPotential.DpfEvaluation)Gets or sets the DpfEvaluation.[`Figures`](#MagneticPotential.Figures)Gets the list of associated figures.[`GlobalIDs`](#MagneticPotential.GlobalIDs)Gets or sets the GlobalIDs.[`GraphControlsXAxis`](#MagneticPotential.GraphControlsXAxis)Gets or sets the GraphControlsXAxis.[`Identifier`](#MagneticPotential.Identifier)Gets or sets the Identifier.[`Images`](#MagneticPotential.Images)Gets the list of associated images.[`InternalObject`](#MagneticPotential.InternalObject)Gets the internal object. For advanced usage only.[`IsSolved`](#MagneticPotential.IsSolved)Gets the IsSolved.[`ItemType`](#MagneticPotential.ItemType)Gets or sets the ItemType.[`IterationNumber`](#MagneticPotential.IterationNumber)Gets the IterationNumber.[`LoadStep`](#MagneticPotential.LoadStep)Gets the LoadStep.[`LoadStepForMaximumOfMaximumValues`](#MagneticPotential.LoadStepForMaximumOfMaximumValues)Get the Load Step for the maximum of maximum values.[`LoadStepForMaximumOfMinimumValues`](#MagneticPotential.LoadStepForMaximumOfMinimumValues)Get the Load Step for the maximum of minimum values.[`LoadStepForMinimumOfMaximumValues`](#MagneticPotential.LoadStepForMinimumOfMaximumValues)Get the Load Step for the minimum of maximum values.[`LoadStepForMinimumOfMinimumValues`](#MagneticPotential.LoadStepForMinimumOfMinimumValues)Get the Load Step for the minimum of minimum values.[`LoadStepNumber`](#MagneticPotential.LoadStepNumber)Gets or sets the LoadStepNumber.[`Location`](#MagneticPotential.Location)Gets or sets the Location.[`Maximum`](#MagneticPotential.Maximum)Gets the Maximum.[`MaximumOccursOn`](#MagneticPotential.MaximumOccursOn)Gets the MaximumOccursOn.[`MaximumOfMaximumOverTime`](#MagneticPotential.MaximumOfMaximumOverTime)Gets the MaximumOfMaximumOverTime.[`MaximumOfMinimumOverTime`](#MagneticPotential.MaximumOfMinimumOverTime)Gets the MaximumOfMinimumOverTime.[`Minimum`](#MagneticPotential.Minimum)Gets the Minimum.[`MinimumOccursOn`](#MagneticPotential.MinimumOccursOn)Gets the MinimumOccursOn.[`MinimumOfMaximumOverTime`](#MagneticPotential.MinimumOfMaximumOverTime)Gets the MinimumOfMaximumOverTime.[`MinimumOfMinimumOverTime`](#MagneticPotential.MinimumOfMinimumOverTime)Gets the MinimumOfMinimumOverTime.[`NamedSelections`](#MagneticPotential.NamedSelections)Gets or sets the NamedSelections.[`Path`](#MagneticPotential.Path)Path property.[`PlotData`](#MagneticPotential.PlotData)Gets the result table.[`Properties`](#MagneticPotential.Properties)Gets the list of properties for this object.[`RPMSelection`](#MagneticPotential.RPMSelection)Gets or sets the RPM Selection value at which the results are evaluated.[`ScopingMethod`](#MagneticPotential.ScopingMethod)Gets or sets the ScopingMethod.[`SetNumber`](#MagneticPotential.SetNumber)Gets or sets the Set Number.[`SolutionCombinationDriver`](#MagneticPotential.SolutionCombinationDriver)Gets or sets the SolutionCombinationDriver.[`SolverComponentIDs`](#MagneticPotential.SolverComponentIDs)Gets or sets the SolverComponentIDs.[`Substep`](#MagneticPotential.Substep)Gets the Substep.[`Suppressed`](#MagneticPotential.Suppressed)Gets or sets the Suppressed.[`Surface`](#MagneticPotential.Surface)Surface property.[`SurfaceCoating`](#MagneticPotential.SurfaceCoating)SurfaceCoating property.[`Time`](#MagneticPotential.Time)Gets the Time.[`TimeForMaximumOfMaximumValues`](#MagneticPotential.TimeForMaximumOfMaximumValues)Get the Time for the maximum of maximum values.[`TimeForMaximumOfMinimumValues`](#MagneticPotential.TimeForMaximumOfMinimumValues)Get the Time for the maximum of minimum values.[`TimeForMinimumOfMaximumValues`](#MagneticPotential.TimeForMinimumOfMaximumValues)Get the Time for the minimum of maximum values.[`TimeForMinimumOfMinimumValues`](#MagneticPotential.TimeForMinimumOfMinimumValues)Get the Time for the minimum of minimum values.[`Total`](#MagneticPotential.Total)Gets the Total.[`VisibleProperties`](#MagneticPotential.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="MagneticPotential.Average"></a>

### *property* MagneticPotential.Average *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Average.

<a id="MagneticPotential.By"></a>

### *property* MagneticPotential.By *: [Ansys.Mechanical.DataModel.Enums.SetDriverStyle](../../../../Mechanical/DataModel/Enums/SetDriverStyle.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.SetDriverStyle) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the By.

<a id="MagneticPotential.CalculateTimeHistory"></a>

### *property* MagneticPotential.CalculateTimeHistory *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CalculateTimeHistory.

<a id="MagneticPotential.Children"></a>

### *property* MagneticPotential.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="MagneticPotential.CombinationNumber"></a>

### *property* MagneticPotential.CombinationNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Combination Number for a Solution Combination result.

<a id="MagneticPotential.Comments"></a>

### *property* MagneticPotential.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="MagneticPotential.CoordinateSystem"></a>

### *property* MagneticPotential.CoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.

<a id="MagneticPotential.CrackFrontNumber"></a>

### *property* MagneticPotential.CrackFrontNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CrackFrontNumber.

<a id="MagneticPotential.DataModelObjectCategory"></a>

### *property* MagneticPotential.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="MagneticPotential.DisplayOption"></a>

### *property* MagneticPotential.DisplayOption *: [Ansys.Mechanical.DataModel.Enums.ResultAveragingType](../../../../Mechanical/DataModel/Enums/ResultAveragingType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.ResultAveragingType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DisplayOption.

<a id="MagneticPotential.DisplayTime"></a>

### *property* MagneticPotential.DisplayTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DisplayTime.

<a id="MagneticPotential.DpfEvaluation"></a>

### *property* MagneticPotential.DpfEvaluation *: [Ansys.Mechanical.DataModel.Enums.DpfEvaluationType](../../../../Mechanical/DataModel/Enums/DpfEvaluationType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.DpfEvaluationType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DpfEvaluation.

<a id="MagneticPotential.Figures"></a>

### *property* MagneticPotential.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="MagneticPotential.GlobalIDs"></a>

### *property* MagneticPotential.GlobalIDs *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GlobalIDs.

<a id="MagneticPotential.GraphControlsXAxis"></a>

### *property* MagneticPotential.GraphControlsXAxis *: [Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis](../../../../Mechanical/DataModel/Enums/GraphControlsXAxis.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GraphControlsXAxis.

<a id="MagneticPotential.Identifier"></a>

### *property* MagneticPotential.Identifier *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Identifier.

<a id="MagneticPotential.Images"></a>

### *property* MagneticPotential.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="MagneticPotential.InternalObject"></a>

### *property* MagneticPotential.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="MagneticPotential.IsSolved"></a>

### *property* MagneticPotential.IsSolved *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IsSolved.

<a id="MagneticPotential.ItemType"></a>

### *property* MagneticPotential.ItemType *: [Ansys.Mechanical.DataModel.Enums.ResultFileItemType](../../../../Mechanical/DataModel/Enums/ResultFileItemType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.ResultFileItemType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ItemType.

<a id="MagneticPotential.IterationNumber"></a>

### *property* MagneticPotential.IterationNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IterationNumber.

<a id="MagneticPotential.LoadStep"></a>

### *property* MagneticPotential.LoadStep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the LoadStep.

<a id="MagneticPotential.LoadStepForMaximumOfMaximumValues"></a>

### *property* MagneticPotential.LoadStepForMaximumOfMaximumValues *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Load Step for the maximum of maximum values.

<a id="MagneticPotential.LoadStepForMaximumOfMinimumValues"></a>

### *property* MagneticPotential.LoadStepForMaximumOfMinimumValues *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Load Step for the maximum of minimum values.

<a id="MagneticPotential.LoadStepForMinimumOfMaximumValues"></a>

### *property* MagneticPotential.LoadStepForMinimumOfMaximumValues *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Load Step for the minimum of maximum values.

<a id="MagneticPotential.LoadStepForMinimumOfMinimumValues"></a>

### *property* MagneticPotential.LoadStepForMinimumOfMinimumValues *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Load Step for the minimum of minimum values.

<a id="MagneticPotential.LoadStepNumber"></a>

### *property* MagneticPotential.LoadStepNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadStepNumber.

<a id="MagneticPotential.Location"></a>

### *property* MagneticPotential.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="MagneticPotential.Maximum"></a>

### *property* MagneticPotential.Maximum *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Maximum.

<a id="MagneticPotential.MaximumOccursOn"></a>

### *property* MagneticPotential.MaximumOccursOn *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumOccursOn.

<a id="MagneticPotential.MaximumOfMaximumOverTime"></a>

### *property* MagneticPotential.MaximumOfMaximumOverTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumOfMaximumOverTime.

<a id="MagneticPotential.MaximumOfMinimumOverTime"></a>

### *property* MagneticPotential.MaximumOfMinimumOverTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumOfMinimumOverTime.

<a id="MagneticPotential.Minimum"></a>

### *property* MagneticPotential.Minimum *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Minimum.

<a id="MagneticPotential.MinimumOccursOn"></a>

### *property* MagneticPotential.MinimumOccursOn *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumOccursOn.

<a id="MagneticPotential.MinimumOfMaximumOverTime"></a>

### *property* MagneticPotential.MinimumOfMaximumOverTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumOfMaximumOverTime.

<a id="MagneticPotential.MinimumOfMinimumOverTime"></a>

### *property* MagneticPotential.MinimumOfMinimumOverTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumOfMinimumOverTime.

<a id="MagneticPotential.NamedSelections"></a>

### *property* MagneticPotential.NamedSelections *: Iterable\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NamedSelections.

<a id="MagneticPotential.Path"></a>

### *property* MagneticPotential.Path *: [Ansys.ACT.Automation.Mechanical.Path](../Path.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Path) | [None](https://docs.python.org/3/library/constants.html#None)*

Path property.

<a id="MagneticPotential.PlotData"></a>

### *property* MagneticPotential.PlotData *: [Ansys.Mechanical.DataModel.Results.ResultDataTable](../../../../Mechanical/DataModel/Results/ResultDataTable.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Results.ResultDataTable) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the result table.

<a id="MagneticPotential.Properties"></a>

### *property* MagneticPotential.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="MagneticPotential.RPMSelection"></a>

### *property* MagneticPotential.RPMSelection *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="MagneticPotential.ScopingMethod"></a>

### *property* MagneticPotential.ScopingMethod *: [Ansys.Mechanical.DataModel.Enums.GeometryDefineByType](../../../../Mechanical/DataModel/Enums/GeometryDefineByType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.GeometryDefineByType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ScopingMethod.

<a id="MagneticPotential.SetNumber"></a>

### *property* MagneticPotential.SetNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Set Number.

<a id="MagneticPotential.SolutionCombinationDriver"></a>

### *property* MagneticPotential.SolutionCombinationDriver *: [Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle](../../../../Mechanical/DataModel/Enums/SolutionCombinationDriverStyle.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SolutionCombinationDriver.

<a id="MagneticPotential.SolverComponentIDs"></a>

### *property* MagneticPotential.SolverComponentIDs *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SolverComponentIDs.

<a id="MagneticPotential.Substep"></a>

### *property* MagneticPotential.Substep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Substep.

<a id="MagneticPotential.Suppressed"></a>

### *property* MagneticPotential.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="MagneticPotential.Surface"></a>

### *property* MagneticPotential.Surface *: [Ansys.ACT.Automation.Mechanical.Surface](../Surface.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Surface) | [None](https://docs.python.org/3/library/constants.html#None)*

Surface property.

<a id="MagneticPotential.SurfaceCoating"></a>

### *property* MagneticPotential.SurfaceCoating *: [Ansys.ACT.Automation.Mechanical.SurfaceCoating](../SurfaceCoating.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.SurfaceCoating) | [None](https://docs.python.org/3/library/constants.html#None)*

SurfaceCoating property.

<a id="MagneticPotential.Time"></a>

### *property* MagneticPotential.Time *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Time.

<a id="MagneticPotential.TimeForMaximumOfMaximumValues"></a>

### *property* MagneticPotential.TimeForMaximumOfMaximumValues *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Time for the maximum of maximum values.

<a id="MagneticPotential.TimeForMaximumOfMinimumValues"></a>

### *property* MagneticPotential.TimeForMaximumOfMinimumValues *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Time for the maximum of minimum values.

<a id="MagneticPotential.TimeForMinimumOfMaximumValues"></a>

### *property* MagneticPotential.TimeForMinimumOfMaximumValues *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Time for the minimum of maximum values.

<a id="MagneticPotential.TimeForMinimumOfMinimumValues"></a>

### *property* MagneticPotential.TimeForMinimumOfMinimumValues *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Get the Time for the minimum of minimum values.

<a id="MagneticPotential.Total"></a>

### *property* MagneticPotential.Total *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Total.

<a id="MagneticPotential.VisibleProperties"></a>

### *property* MagneticPotential.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="method-detail"></a>

## Method detail

<a id="MagneticPotential.Activate"></a>

### MagneticPotential.Activate()

Activate the current object.

<a id="MagneticPotential.AddAlert"></a>

### MagneticPotential.AddAlert()

Creates a new Alert

<a id="MagneticPotential.AddComment"></a>

### MagneticPotential.AddComment()

Creates a new child Comment.

<a id="MagneticPotential.AddConvergence"></a>

### MagneticPotential.AddConvergence()

Creates a new Convergence

<a id="MagneticPotential.AddFigure"></a>

### MagneticPotential.AddFigure()

Creates a new child Figure.

<a id="MagneticPotential.AddImage"></a>

### MagneticPotential.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
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.

```

<a id="MagneticPotential.ClearGeneratedData"></a>

### MagneticPotential.ClearGeneratedData()

Run the ClearGeneratedData action.

<a id="MagneticPotential.CopyTo"></a>

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

Copies all visible properties from this object to another.

<a id="MagneticPotential.CreateParameter"></a>

### MagneticPotential.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

CreateParameter method.

<a id="MagneticPotential.CreateResultsAtAllSets"></a>

### MagneticPotential.CreateResultsAtAllSets()

Creates results at all sets for results under a solution.

<a id="MagneticPotential.Delete"></a>

### MagneticPotential.Delete()

Run the Delete action.

<a id="MagneticPotential.Duplicate"></a>

### MagneticPotential.Duplicate()

Creates a copy of the current DataModelObject.

<a id="MagneticPotential.DuplicateWithoutResults"></a>

### MagneticPotential.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

<a id="MagneticPotential.EvaluateAllResults"></a>

### MagneticPotential.EvaluateAllResults()

Run the EvaluateAllResults action.

<a id="MagneticPotential.ExportAnimation"></a>

### MagneticPotential.ExportAnimation(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str), format: [Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat](../../../../Mechanical/DataModel/Enums/GraphicsAnimationExportFormat.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat), settings: [Ansys.Mechanical.Graphics.AnimationExportSettings](../../../../Mechanical/Graphics/AnimationExportSettings.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.Graphics.AnimationExportSettings))

Run the ExportAnimation action.

<a id="MagneticPotential.ExportToTextFile"></a>

### MagneticPotential.ExportToTextFile(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

Run the ExportToTextFile action.

<a id="MagneticPotential.FetchRemoteResults"></a>

### MagneticPotential.FetchRemoteResults()

Run the FetchRemoteResult action.

<a id="MagneticPotential.GetChildren"></a>

### MagneticPotential.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="MagneticPotential.GetParameter"></a>

### MagneticPotential.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="MagneticPotential.GroupAllSimilarChildren"></a>

### MagneticPotential.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="MagneticPotential.GroupSimilarObjects"></a>

### MagneticPotential.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="MagneticPotential.PromoteToNamedSelection"></a>

### MagneticPotential.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

<a id="MagneticPotential.PropertyByAPIName"></a>

### MagneticPotential.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
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.

```

<a id="MagneticPotential.PropertyByName"></a>

### MagneticPotential.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="MagneticPotential.RemoveParameter"></a>

### MagneticPotential.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

<a id="MagneticPotential.RenameBasedOnDefinition"></a>

### MagneticPotential.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.