EnergyProbe
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.EnergyProbe#
Bases:
object
Defines a EnergyProbe.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Run the ClearGeneratedData action. |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
Run the DuplicateWithoutResults action. |
|
Run the EvaluateAllResults action. |
|
Run the ExportAnimation action. |
|
Gets the list of children, filtered by type. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Run the RenameBasedOnDefinition action. |
|
Snap the coordinates of probe result to the mesh nodes. |
Gets or sets the BeamSelection. |
|
Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'. |
|
Gets or sets the By. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the ContactEnergy. |
|
Gets or sets the ContactRegionSelection. |
|
Gets or sets the CoordinateSystemSelection. |
|
Gets the DampingEnergy. |
|
Gets the current DataModelObject's category. |
|
Gets or sets the DisplayTime. |
|
Gets or sets the DpfEvaluation. |
|
Gets the ExternalEnergy. |
|
Gets the list of associated figures. |
|
Gets or sets the Frequency. |
|
Gets or sets the GeometryLocation. |
|
Gets the HourglassEnergy. |
|
Gets the list of associated images. |
|
Gets the InternalEnergy. |
|
Gets the internal object. For advanced usage only. |
|
Gets the IsSolved. |
|
Gets the IterationNumber. |
|
Gets the KineticEnergy. |
|
Gets the LoadStep. |
|
Gets or sets the LoadStepNumber. |
|
Gets or sets the LocationMethod. |
|
Gets the MagnetostaticCoEnergy. |
|
Gets the MaxMagnetostaticCoEnergyOverTime. |
|
Gets the MaximumContactEnergy. |
|
Gets the MaximumDampingEnergy. |
|
Gets the MaximumExternalEnergy. |
|
Gets the MaximumHourglassEnergy. |
|
Gets the MaximumInternalEnergy. |
|
Gets the MaximumKineticEnergy. |
|
Gets the MaximumPlasticWork. |
|
Gets the MaximumPotentialEnergy. |
|
Gets the MaximumStrainEnergy. |
|
Gets the MaximumTotal. |
|
Gets the MaximumTotalEnergy. |
|
Gets the MaximumXAxis. |
|
Gets the MaximumYAxis. |
|
Gets the MaximumZAxis. |
|
Gets or sets the MeshConnectionSelection. |
|
Gets the MinMagnetostaticCoEnergyOverTime. |
|
Gets the MinimumContactEnergy. |
|
Gets the MinimumDampingEnergy. |
|
Gets the MinimumExternalEnergy. |
|
Gets the MinimumHourglassEnergy. |
|
Gets the MinimumInternalEnergy. |
|
Gets the MinimumKineticEnergy. |
|
Gets the MinimumPlasticWork. |
|
Gets the MinimumPotentialEnergy. |
|
Gets the MinimumStrainEnergy. |
|
Gets the MinimumTotal. |
|
Gets the MinimumTotalEnergy. |
|
Gets the MinimumXAxis. |
|
Gets the MinimumYAxis. |
|
Gets the MinimumZAxis. |
|
Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System. |
|
Gets the PlasticWork. |
|
Gets the PotentialEnergy. |
|
Gets the list of properties for this object. |
|
Gets or sets the RemotePointSelection. |
|
Gets the ReportedFrequency. |
|
Gets or sets the ResultSelection. |
|
Gets or sets the SetNumber. |
|
Gets or sets the SpatialResolution. |
|
Gets or sets the SpringSelection. |
|
Gets the StrainEnergy. |
|
Gets the Substep. |
|
Gets or sets the Summation. |
|
Gets or sets the Suppressed. |
|
Gets or sets the MeshConnectionSelection. |
|
Gets the Time. |
|
Gets the Total. |
|
Gets the TotalEnergy. |
|
Gets the Type. |
|
Gets the list of properties that are visible for this object. |
|
Gets the XAxis. |
|
Gets the YAxis. |
|
Gets the ZAxis. |
Property detail#
- property EnergyProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None#
Gets or sets the BeamSelection.
- property EnergyProbe.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 EnergyProbe.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None#
Gets or sets the By.
- property EnergyProbe.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets the list of children.
- property EnergyProbe.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#
Gets the list of associated comments.
- property EnergyProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None#
Gets or sets the ContactRegionSelection.
- property EnergyProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
Gets or sets the CoordinateSystemSelection.
- property EnergyProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#
Gets the current DataModelObject's category.
- property EnergyProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#
Gets or sets the DpfEvaluation.
- property EnergyProbe.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#
Gets the list of associated figures.
- property EnergyProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#
Gets or sets the GeometryLocation.
- property EnergyProbe.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#
Gets the list of associated images.
- property EnergyProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#
Gets the internal object. For advanced usage only.
- property EnergyProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#
Gets or sets the LocationMethod.
- property EnergyProbe.MagnetostaticCoEnergy: Ansys.Core.Units.Quantity | None#
Gets the MagnetostaticCoEnergy.
- property EnergyProbe.MaxMagnetostaticCoEnergyOverTime: Ansys.Core.Units.Quantity | None#
Gets the MaxMagnetostaticCoEnergyOverTime.
- property EnergyProbe.MaximumContactEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumContactEnergy.
- property EnergyProbe.MaximumDampingEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumDampingEnergy.
- property EnergyProbe.MaximumExternalEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumExternalEnergy.
- property EnergyProbe.MaximumHourglassEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumHourglassEnergy.
- property EnergyProbe.MaximumInternalEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumInternalEnergy.
- property EnergyProbe.MaximumKineticEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumKineticEnergy.
- property EnergyProbe.MaximumPlasticWork: Ansys.Core.Units.Quantity | None#
Gets the MaximumPlasticWork.
- property EnergyProbe.MaximumPotentialEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumPotentialEnergy.
- property EnergyProbe.MaximumStrainEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumStrainEnergy.
- property EnergyProbe.MaximumTotalEnergy: Ansys.Core.Units.Quantity | None#
Gets the MaximumTotalEnergy.
- property EnergyProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#
Gets or sets the MeshConnectionSelection.
- property EnergyProbe.MinMagnetostaticCoEnergyOverTime: Ansys.Core.Units.Quantity | None#
Gets the MinMagnetostaticCoEnergyOverTime.
- property EnergyProbe.MinimumContactEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumContactEnergy.
- property EnergyProbe.MinimumDampingEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumDampingEnergy.
- property EnergyProbe.MinimumExternalEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumExternalEnergy.
- property EnergyProbe.MinimumHourglassEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumHourglassEnergy.
- property EnergyProbe.MinimumInternalEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumInternalEnergy.
- property EnergyProbe.MinimumKineticEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumKineticEnergy.
- property EnergyProbe.MinimumPlasticWork: Ansys.Core.Units.Quantity | None#
Gets the MinimumPlasticWork.
- property EnergyProbe.MinimumPotentialEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumPotentialEnergy.
- property EnergyProbe.MinimumStrainEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumStrainEnergy.
- property EnergyProbe.MinimumTotalEnergy: Ansys.Core.Units.Quantity | None#
Gets the MinimumTotalEnergy.
- property EnergyProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
- property EnergyProbe.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties for this object.
- property EnergyProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#
Gets or sets the RemotePointSelection.
- property EnergyProbe.ReportedFrequency: Ansys.Core.Units.Quantity | None#
Gets the ReportedFrequency.
- property EnergyProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#
Gets or sets the ResultSelection.
- property EnergyProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#
Gets or sets the SpatialResolution.
- property EnergyProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None#
Gets or sets the SpringSelection.
- property EnergyProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#
Gets or sets the Summation.
- property EnergyProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#
Gets or sets the MeshConnectionSelection.
- property EnergyProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#
Gets the Type.
Method detail#
- EnergyProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment #
Creates a new child Comment.
- EnergyProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure #
Creates a new child Figure.
- EnergyProbe.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.
- EnergyProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None #
Copies all visible properties from this object to another.
- EnergyProbe.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Creates a new parameter for a Property.
- EnergyProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject #
Creates a copy of the current DataModelObject.
- EnergyProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject #
Run the DuplicateWithoutResults action.
- EnergyProbe.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None #
Run the ExportAnimation action.
- EnergyProbe.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType] #
Gets the list of children, filtered by type.
- EnergyProbe.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Gets the parameter corresponding to the given property.
- EnergyProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
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.
- EnergyProbe.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property #
Get a property by its unique name.