FractureJINTProbe#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureJINTProbe#

Bases: object

Defines a FractureJINTProbe.

Overview#

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.

ActiveContour

Gets or sets the ActiveContour.

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.

CrackLengthPercentage

Gets or sets the CrackLengthPercentage.

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.

MaximumValueOverTime

Gets the MaximumValueOverTime.

MaximumXAxis

Gets the MaximumXAxis.

MaximumYAxis

Gets the MaximumYAxis.

MaximumZAxis

Gets the MaximumZAxis.

MeshConnectionSelection

Gets or sets the MeshConnectionSelection.

MinimumTotal

Gets the MinimumTotal.

MinimumValueOverTime

Gets the MinimumValueOverTime.

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.

RemotePointSelection

Gets or sets the RemotePointSelection.

ResultProbeValue

Gets the ResultProbeValue.

ResultSelection

Gets or sets the ResultSelection.

SolverID

Gets or sets the SolverID.

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.

ZAxis

Gets the ZAxis.

Property detail#

property FractureJINTProbe.ActiveContour: int | None#

Gets or sets the ActiveContour.

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

Gets or sets the BeamSelection.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

property FractureJINTProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystemSelection.

property FractureJINTProbe.CrackLengthPercentage: int | None#

Gets or sets the CrackLengthPercentage.

property FractureJINTProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property FractureJINTProbe.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property FractureJINTProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property FractureJINTProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property FractureJINTProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#

Gets the internal object. For advanced usage only.

property FractureJINTProbe.IsSolved: bool | None#

Gets the IsSolved.

property FractureJINTProbe.IterationNumber: int | None#

Gets the IterationNumber.

property FractureJINTProbe.LoadStep: int | None#

Gets the LoadStep.

property FractureJINTProbe.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property FractureJINTProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#

Gets or sets the LocationMethod.

property FractureJINTProbe.MaximumTotal: Ansys.Core.Units.Quantity | None#

Gets the MaximumTotal.

property FractureJINTProbe.MaximumValueOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumValueOverTime.

property FractureJINTProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumXAxis.

property FractureJINTProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumYAxis.

property FractureJINTProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumZAxis.

property FractureJINTProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#

Gets or sets the MeshConnectionSelection.

property FractureJINTProbe.MinimumTotal: Ansys.Core.Units.Quantity | None#

Gets the MinimumTotal.

property FractureJINTProbe.MinimumValueOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumValueOverTime.

property FractureJINTProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumXAxis.

property FractureJINTProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumYAxis.

property FractureJINTProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumZAxis.

property FractureJINTProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

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

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

Gets the list of properties for this object.

property FractureJINTProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePointSelection.

property FractureJINTProbe.ResultProbeValue: Ansys.Core.Units.Quantity | None#

Gets the ResultProbeValue.

property FractureJINTProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#

Gets or sets the ResultSelection.

property FractureJINTProbe.SolverID: int | None#

Gets or sets the SolverID.

property FractureJINTProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property FractureJINTProbe.Substep: int | None#

Gets the Substep.

property FractureJINTProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#

Gets or sets the Summation.

property FractureJINTProbe.Suppressed: bool | None#

Gets or sets the Suppressed.

property FractureJINTProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#

Gets or sets the MeshConnectionSelection.

property FractureJINTProbe.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property FractureJINTProbe.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property FractureJINTProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#

Gets the Type.

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

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

property FractureJINTProbe.XAxis: Ansys.Core.Units.Quantity | None#

Gets the XAxis.

property FractureJINTProbe.YAxis: Ansys.Core.Units.Quantity | None#

Gets the YAxis.

property FractureJINTProbe.ZAxis: Ansys.Core.Units.Quantity | None#

Gets the ZAxis.

Method detail#

FractureJINTProbe.Activate() None#

Activate the current object.

FractureJINTProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

FractureJINTProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

FractureJINTProbe.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.
FractureJINTProbe.ClearGeneratedData() None#

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

FractureJINTProbe.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

FractureJINTProbe.Delete() None#

Run the Delete action.

FractureJINTProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

FractureJINTProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject#

Run the DuplicateWithoutResults action.

FractureJINTProbe.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

FractureJINTProbe.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

FractureJINTProbe.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

FractureJINTProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

FractureJINTProbe.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.
FractureJINTProbe.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

FractureJINTProbe.RemoveParameter(propName: str) None#

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

FractureJINTProbe.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

FractureJINTProbe.SnapToMeshNodes() None#

Snap the coordinates of probe result to the mesh nodes.