MagneticPotential

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.MagneticPotential

Bases: object

Defines a MagneticPotential.

Overview

Methods

Activate	Activate the current object.
AddAlert	Creates a new Alert
AddComment	Creates a new child Comment.
AddConvergence	Creates a new Convergence
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	CreateParameter method.
CreateResultsAtAllSets	Creates results at all sets for results under a solution.
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.
ExportToTextFile	Run the ExportToTextFile action.
FetchRemoteResults	Run the FetchRemoteResult 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.
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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.

Properties

Average	Gets the Average.
By	Gets or sets the By.
CalculateTimeHistory	Gets or sets the CalculateTimeHistory.
Children	Gets the list of children.
CombinationNumber	Gets or sets the Combination Number for a Solution Combination result.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the Coordinate System.
CrackFrontNumber	Gets or sets the CrackFrontNumber.
DataModelObjectCategory	Gets the current DataModelObject's category.
DisplayOption	Gets or sets the DisplayOption.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
Figures	Gets the list of associated figures.
GlobalIDs	Gets or sets the GlobalIDs.
GraphControlsXAxis	Gets or sets the GraphControlsXAxis.
Identifier	Gets or sets the Identifier.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IsSolved	Gets the IsSolved.
ItemType	Gets or sets the ItemType.
IterationNumber	Gets the IterationNumber.
LoadStep	Gets the LoadStep.
LoadStepForMaximumOfMaximumValues	Get the Load Step for the maximum of maximum values.
LoadStepForMaximumOfMinimumValues	Get the Load Step for the maximum of minimum values.
LoadStepForMinimumOfMaximumValues	Get the Load Step for the minimum of maximum values.
LoadStepForMinimumOfMinimumValues	Get the Load Step for the minimum of minimum values.
LoadStepNumber	Gets or sets the LoadStepNumber.
Location	Gets or sets the Location.
Maximum	Gets the Maximum.
MaximumOccursOn	Gets the MaximumOccursOn.
MaximumOfMaximumOverTime	Gets the MaximumOfMaximumOverTime.
MaximumOfMinimumOverTime	Gets the MaximumOfMinimumOverTime.
Minimum	Gets the Minimum.
MinimumOccursOn	Gets the MinimumOccursOn.
MinimumOfMaximumOverTime	Gets the MinimumOfMaximumOverTime.
MinimumOfMinimumOverTime	Gets the MinimumOfMinimumOverTime.
NamedSelections	Gets or sets the NamedSelections.
Path	Path property.
PlotData	Gets the result table.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
SetNumber	Gets or sets the Set Number.
SolutionCombinationDriver	Gets or sets the SolutionCombinationDriver.
SolverComponentIDs	Gets or sets the SolverComponentIDs.
Substep	Gets the Substep.
Suppressed	Gets or sets the Suppressed.
Surface	Surface property.
Time	Gets the Time.
TimeForMaximumOfMaximumValues	Get the Time for the maximum of maximum values.
TimeForMaximumOfMinimumValues	Get the Time for the maximum of minimum values.
TimeForMinimumOfMaximumValues	Get the Time for the minimum of maximum values.
TimeForMinimumOfMinimumValues	Get the Time for the minimum of minimum values.
VisibleProperties	Gets the list of properties that are visible for this object.
WaterfallPanelShowTextOnMosaic	Gets or sets the Waterfall Panel Mosaic Text Property.

Property detail

property MagneticPotential.Average: Ansys.Core.Units.Quantity | None

Gets the Average.

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

Gets or sets the By.

property MagneticPotential.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property MagneticPotential.CombinationNumber: int | None

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

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

Gets the list of associated comments.

property MagneticPotential.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | 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.

property MagneticPotential.CrackFrontNumber: int | None

Gets or sets the CrackFrontNumber.

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

Gets the current DataModelObject's category.

property MagneticPotential.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property MagneticPotential.GlobalIDs: str | None

Gets or sets the GlobalIDs.

property MagneticPotential.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None

Gets or sets the GraphControlsXAxis.

property MagneticPotential.Identifier: str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

property MagneticPotential.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None

Gets the internal object. For advanced usage only.

property MagneticPotential.IsSolved: bool | None

Gets the IsSolved.

property MagneticPotential.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None

Gets or sets the ItemType.

property MagneticPotential.IterationNumber: int | None

Gets the IterationNumber.

property MagneticPotential.LoadStep: int | None

Gets the LoadStep.

property MagneticPotential.LoadStepForMaximumOfMaximumValues: int | None

Get the Load Step for the maximum of maximum values.

property MagneticPotential.LoadStepForMaximumOfMinimumValues: int | None

Get the Load Step for the maximum of minimum values.

property MagneticPotential.LoadStepForMinimumOfMaximumValues: int | None

Get the Load Step for the minimum of maximum values.

property MagneticPotential.LoadStepForMinimumOfMinimumValues: int | None

Get the Load Step for the minimum of minimum values.

property MagneticPotential.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

property MagneticPotential.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property MagneticPotential.Maximum: Ansys.Core.Units.Quantity | None

Gets the Maximum.

property MagneticPotential.MaximumOccursOn: str | None

Gets the MaximumOccursOn.

property MagneticPotential.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumOfMaximumOverTime.

property MagneticPotential.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumOfMinimumOverTime.

property MagneticPotential.Minimum: Ansys.Core.Units.Quantity | None

Gets the Minimum.

property MagneticPotential.MinimumOccursOn: str | None

Gets the MinimumOccursOn.

property MagneticPotential.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumOfMaximumOverTime.

property MagneticPotential.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumOfMinimumOverTime.

property MagneticPotential.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets or sets the NamedSelections.

property MagneticPotential.Path: Ansys.ACT.Automation.Mechanical.Path | None

Path property.

property MagneticPotential.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None

Gets the result table.

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

Gets the list of properties for this object.

property MagneticPotential.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property MagneticPotential.SetNumber: int | None

Gets or sets the Set Number.

property MagneticPotential.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None

Gets or sets the SolutionCombinationDriver.

property MagneticPotential.SolverComponentIDs: str | None

Gets or sets the SolverComponentIDs.

property MagneticPotential.Substep: int | None

Gets the Substep.

property MagneticPotential.Suppressed: bool | None

Gets or sets the Suppressed.

property MagneticPotential.Surface: Ansys.ACT.Automation.Mechanical.Surface | None

Surface property.

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

Gets the Time.

property MagneticPotential.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None

Get the Time for the maximum of maximum values.

property MagneticPotential.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None

Get the Time for the maximum of minimum values.

property MagneticPotential.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None

Get the Time for the minimum of maximum values.

property MagneticPotential.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None

Get the Time for the minimum of minimum values.

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

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

property MagneticPotential.WaterfallPanelShowTextOnMosaic: bool | None

Gets or sets the Waterfall Panel Mosaic Text Property.

Method detail

MagneticPotential.Activate() → None

Activate the current object.

MagneticPotential.AddAlert() → Ansys.ACT.Automation.Mechanical.Results.Alert

Creates a new Alert

MagneticPotential.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

MagneticPotential.AddConvergence() → Ansys.ACT.Automation.Mechanical.Results.Convergence

Creates a new Convergence

MagneticPotential.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

MagneticPotential.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

MagneticPotential.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

CreateParameter method.

MagneticPotential.CreateResultsAtAllSets() → List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Creates results at all sets for results under a solution.

MagneticPotential.Delete() → None

Run the Delete action.

MagneticPotential.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

MagneticPotential.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Run the DuplicateWithoutResults action.

MagneticPotential.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

MagneticPotential.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

MagneticPotential.FetchRemoteResults() → None

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

MagneticPotential.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

MagneticPotential.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

MagneticPotential.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

MagneticPotential.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

MagneticPotential.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

MagneticPotential.RemoveParameter(propName: str) → None

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

MagneticPotential.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.