MagneticCoenergy
Last update: 14.01.2025
MagneticCoenergy
class Ansys.ACT.Automation.Mechanical.Results.MagneticCoenergy
Bases: object
Defines a MagneticCoenergy.
Overview
Methods
Name | Description |
---|---|
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
Name | Description |
---|---|
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. |
RPMSelection |
Gets or sets the RPM Selection value at which the results are evaluated. |
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. |
SurfaceCoating |
SurfaceCoating 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. |
Total |
Gets the Total. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property MagneticCoenergy.Average : Ansys.Core.Units.Quantity | None
Gets the Average.
property MagneticCoenergy.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None
Gets or sets the By.
property MagneticCoenergy.CalculateTimeHistory : bool | None
Gets or sets the CalculateTimeHistory.
property MagneticCoenergy.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property MagneticCoenergy.CombinationNumber : int | None
Gets or sets the Combination Number for a Solution Combination result.
property MagneticCoenergy.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property MagneticCoenergy.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 MagneticCoenergy.CrackFrontNumber : int | None
Gets or sets the CrackFrontNumber.
property MagneticCoenergy.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property MagneticCoenergy.DisplayOption : Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None
Gets or sets the DisplayOption.
property MagneticCoenergy.DisplayTime : Ansys.Core.Units.Quantity | None
Gets or sets the DisplayTime.
property MagneticCoenergy.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None
Gets or sets the DpfEvaluation.
property MagneticCoenergy.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property MagneticCoenergy.GlobalIDs : str | None
Gets or sets the GlobalIDs.
property MagneticCoenergy.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None
Gets or sets the GraphControlsXAxis.
property MagneticCoenergy.Identifier : str | None
Gets or sets the Identifier.
property MagneticCoenergy.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property MagneticCoenergy.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None
Gets the internal object. For advanced usage only.
property MagneticCoenergy.IsSolved : bool | None
Gets the IsSolved.
property MagneticCoenergy.ItemType : Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None
Gets or sets the ItemType.
property MagneticCoenergy.IterationNumber : int | None
Gets the IterationNumber.
property MagneticCoenergy.LoadStep : int | None
Gets the LoadStep.
property MagneticCoenergy.LoadStepForMaximumOfMaximumValues : int | None
Get the Load Step for the maximum of maximum values.
property MagneticCoenergy.LoadStepForMaximumOfMinimumValues : int | None
Get the Load Step for the maximum of minimum values.
property MagneticCoenergy.LoadStepForMinimumOfMaximumValues : int | None
Get the Load Step for the minimum of maximum values.
property MagneticCoenergy.LoadStepForMinimumOfMinimumValues : int | None
Get the Load Step for the minimum of minimum values.
property MagneticCoenergy.LoadStepNumber : int | None
Gets or sets the LoadStepNumber.
property MagneticCoenergy.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property MagneticCoenergy.Maximum : Ansys.Core.Units.Quantity | None
Gets the Maximum.
property MagneticCoenergy.MaximumOccursOn : str | None
Gets the MaximumOccursOn.
property MagneticCoenergy.MaximumOfMaximumOverTime : Ansys.Core.Units.Quantity | None
Gets the MaximumOfMaximumOverTime.
property MagneticCoenergy.MaximumOfMinimumOverTime : Ansys.Core.Units.Quantity | None
Gets the MaximumOfMinimumOverTime.
property MagneticCoenergy.Minimum : Ansys.Core.Units.Quantity | None
Gets the Minimum.
property MagneticCoenergy.MinimumOccursOn : str | None
Gets the MinimumOccursOn.
property MagneticCoenergy.MinimumOfMaximumOverTime : Ansys.Core.Units.Quantity | None
Gets the MinimumOfMaximumOverTime.
property MagneticCoenergy.MinimumOfMinimumOverTime : Ansys.Core.Units.Quantity | None
Gets the MinimumOfMinimumOverTime.
property MagneticCoenergy.NamedSelections : Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets or sets the NamedSelections.
property MagneticCoenergy.Path : Ansys.ACT.Automation.Mechanical.Path | None
Path property.
property MagneticCoenergy.PlotData : Ansys.Mechanical.DataModel.Results.ResultDataTable | None
Gets the result table.
property MagneticCoenergy.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property MagneticCoenergy.RPMSelection : Ansys.Core.Units.Quantity | None
Gets or sets the RPM Selection value at which the results are evaluated.
property MagneticCoenergy.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None
Gets or sets the ScopingMethod.
property MagneticCoenergy.SetNumber : int | None
Gets or sets the Set Number.
property MagneticCoenergy.SolutionCombinationDriver : Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None
Gets or sets the SolutionCombinationDriver.
property MagneticCoenergy.SolverComponentIDs : str | None
Gets or sets the SolverComponentIDs.
property MagneticCoenergy.Substep : int | None
Gets the Substep.
property MagneticCoenergy.Suppressed : bool | None
Gets or sets the Suppressed.
property MagneticCoenergy.Surface : Ansys.ACT.Automation.Mechanical.Surface | None
Surface property.
property MagneticCoenergy.SurfaceCoating : Ansys.ACT.Automation.Mechanical.SurfaceCoating | None
SurfaceCoating property.
property MagneticCoenergy.Time : Ansys.Core.Units.Quantity | None
Gets the Time.
property MagneticCoenergy.TimeForMaximumOfMaximumValues : Ansys.Core.Units.Quantity | None
Get the Time for the maximum of maximum values.
property MagneticCoenergy.TimeForMaximumOfMinimumValues : Ansys.Core.Units.Quantity | None
Get the Time for the maximum of minimum values.
property MagneticCoenergy.TimeForMinimumOfMaximumValues : Ansys.Core.Units.Quantity | None
Get the Time for the minimum of maximum values.
property MagneticCoenergy.TimeForMinimumOfMinimumValues : Ansys.Core.Units.Quantity | None
Get the Time for the minimum of minimum values.
property MagneticCoenergy.Total : Ansys.Core.Units.Quantity | None
Gets the Total.
property MagneticCoenergy.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
MagneticCoenergy.Activate()
Activate the current object.
MagneticCoenergy.AddAlert()
Creates a new Alert
MagneticCoenergy.AddComment()
Creates a new child Comment.
MagneticCoenergy.AddConvergence()
Creates a new Convergence
MagneticCoenergy.AddFigure()
Creates a new child Figure.
MagneticCoenergy.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.
MagneticCoenergy.ClearGeneratedData()
Run the ClearGeneratedData action.
MagneticCoenergy.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
MagneticCoenergy.CreateParameter(propName: str)
CreateParameter method.
MagneticCoenergy.CreateResultsAtAllSets()
Creates results at all sets for results under a solution.
MagneticCoenergy.Delete()
Run the Delete action.
MagneticCoenergy.Duplicate()
Creates a copy of the current DataModelObject.
MagneticCoenergy.DuplicateWithoutResults()
Run the DuplicateWithoutResults action.
MagneticCoenergy.EvaluateAllResults()
Run the EvaluateAllResults action.
MagneticCoenergy.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings)
Run the ExportAnimation action.
MagneticCoenergy.ExportToTextFile(filePath: str)
Run the ExportToTextFile action.
MagneticCoenergy.FetchRemoteResults()
Run the FetchRemoteResult action.
MagneticCoenergy.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
MagneticCoenergy.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
MagneticCoenergy.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
MagneticCoenergy.GroupSimilarObjects()
Run the GroupSimilarObjects action.
MagneticCoenergy.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
MagneticCoenergy.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.
MagneticCoenergy.PropertyByName(name: str)
Get a property by its unique name.
MagneticCoenergy.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
MagneticCoenergy.RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.