Skip to main content

Mechanical scripting interface

ImportedFiberRatio

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedFiberRatio

Bases: object

Defines a ImportedFiberRatio.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddMappingValidation Creates a new MappingValidation
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.
ExportToTextFile Run the ExportToTextFile action.
GetActivateAtLoadStep GetActivateAtLoadStep method.
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.
Import Import.
ImportLoad Run the ImportLoad action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
ReloadConfiguration Reload the Imported Load’s setup from its associated configuration file (if available).
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep SetActivateAtLoadStep method.

Properties

Name Description
Algorithm Algorithm property.
ApplyAs This controls how the imported load is applied, either as a boundary condition or an initial condition.
BoundingBoxTolerance BoundingBoxTolerance property.
Children Gets the list of children.
Comments Gets the list of associated comments.
CreateNameSelectionForMappedNodes CreateNameSelectionForMappedNodes property.
CreateNameSelectionForOutsideNodes CreateNameSelectionForOutsideNodes property.
CreateNameSelectionForUnmappedNodes CreateNameSelectionForUnmappedNodes property.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayInteriorPoints DisplayInteriorPoints property.
DisplayProjectionPlane DisplayProjectionPlane property.
DisplaySourcePointIds DisplaySourcePointIds property.
DisplaySourcePoints DisplaySourcePoints property.
ExtrapolationTolerancePercent ExtrapolationTolerancePercent property.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Interpolation Interpolation property.
KrigingCorrelationFunction KrigingCorrelationFunction property.
KrigingPolynom KrigingPolynom property.
Limit Limit property.
Location Gets or sets the Location.
MappedNodesName MappedNodesName property.
Mapping Mapping property.
MappingControl MappingControl property.
MaxOutsideDistance MaxOutsideDistance property.
Method Method property.
NumberOfPoints NumberOfPoints property.
OrientationRealignment OrientationRealignment property.
OutsideDistanceCheck OutsideDistanceCheck property.
OutsideNodesName OutsideNodesName property.
OutsideOption OutsideOption property.
Pinball Pinball property.
Projection Projection property.
Properties Gets the list of properties for this object.
RigidBodyTransformationType RigidBodyTransformationType property.
RigidTransformSourceCoordinateSystem RigidTransformSourceCoordinateSystem property.
RigidTransformTargetCoordinateSystem RigidTransformTargetCoordinateSystem property.
SharedRefBody Gets or sets the SharedRefBody.
ShellThicknessFactor ShellThicknessFactor property.
SourceMaximum SourceMaximum property.
SourceMinimum SourceMinimum property.
Suppressed Gets or sets the Suppressed.
UnmappedNodesName UnmappedNodesName property.
VariableType VariableType property.
VisibleProperties Gets the list of properties that are visible for this object.
Weighting Weighting property.

Property detail

property ImportedFiberRatio.Algorithm : Ansys.Mechanical.DataModel.Enums.MappingAlgorithm | None

Algorithm property.

property ImportedFiberRatio.ApplyAs : Ansys.Mechanical.DataModel.Enums.ExternalLoadApplicationType | None

This controls how the imported load is applied, either as a boundary condition or an initial condition.

property ImportedFiberRatio.BoundingBoxTolerance : Ansys.Core.Units.Quantity | None

BoundingBoxTolerance property.

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

Gets the list of children.

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

Gets the list of associated comments.

property ImportedFiberRatio.CreateNameSelectionForMappedNodes : bool | None

CreateNameSelectionForMappedNodes property.

property ImportedFiberRatio.CreateNameSelectionForOutsideNodes : bool | None

CreateNameSelectionForOutsideNodes property.

property ImportedFiberRatio.CreateNameSelectionForUnmappedNodes : bool | None

CreateNameSelectionForUnmappedNodes property.

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

Gets the current DataModelObject’s category.

property ImportedFiberRatio.DisplayInteriorPoints : bool | None

DisplayInteriorPoints property.

property ImportedFiberRatio.DisplayProjectionPlane : bool | None

DisplayProjectionPlane property.

property ImportedFiberRatio.DisplaySourcePointIds : bool | None

DisplaySourcePointIds property.

property ImportedFiberRatio.DisplaySourcePoints : bool | None

DisplaySourcePoints property.

property ImportedFiberRatio.ExtrapolationTolerancePercent : float | None

ExtrapolationTolerancePercent property.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ImportedFiberRatio.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSExternalLoadAuto | None

Gets the internal object. For advanced usage only.

property ImportedFiberRatio.Interpolation : Ansys.Mechanical.DataModel.Enums.InterpolationType | None

Interpolation property.

property ImportedFiberRatio.KrigingCorrelationFunction : Ansys.Mechanical.DataModel.Enums.KrigingCorrFuncType | None

KrigingCorrelationFunction property.

property ImportedFiberRatio.KrigingPolynom : Ansys.Mechanical.DataModel.Enums.KrigingPolynomType | None

KrigingPolynom property.

property ImportedFiberRatio.Limit : int | None

Limit property.

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

Gets or sets the Location.

property ImportedFiberRatio.MappedNodesName : str | None

MappedNodesName property.

property ImportedFiberRatio.Mapping : Ansys.Mechanical.DataModel.Enums.MappingInterpolationType | None

Mapping property.

property ImportedFiberRatio.MappingControl : Ansys.Mechanical.DataModel.Enums.MappingControlType | None

MappingControl property.

property ImportedFiberRatio.MaxOutsideDistance : Ansys.Core.Units.Quantity | None

MaxOutsideDistance property.

property ImportedFiberRatio.Method : Ansys.Mechanical.DataModel.Enums.MappingMethod | None

Method property.

property ImportedFiberRatio.NumberOfPoints : int | None

NumberOfPoints property.

property ImportedFiberRatio.OrientationRealignment : bool | None

OrientationRealignment property.

property ImportedFiberRatio.OutsideDistanceCheck : bool | None

OutsideDistanceCheck property.

property ImportedFiberRatio.OutsideNodesName : str | None

OutsideNodesName property.

property ImportedFiberRatio.OutsideOption : Ansys.Mechanical.DataModel.Enums.MappingOutsideOption | None

OutsideOption property.

property ImportedFiberRatio.Pinball : Ansys.Core.Units.Quantity | None

Pinball property.

property ImportedFiberRatio.Projection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Projection property.

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

Gets the list of properties for this object.

property ImportedFiberRatio.RigidBodyTransformationType : Ansys.Mechanical.DataModel.Enums.RigidBodyTransformationType | None

RigidBodyTransformationType property.

property ImportedFiberRatio.RigidTransformSourceCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

RigidTransformSourceCoordinateSystem property.

property ImportedFiberRatio.RigidTransformTargetCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

RigidTransformTargetCoordinateSystem property.

property ImportedFiberRatio.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property ImportedFiberRatio.ShellThicknessFactor : float | None

ShellThicknessFactor property.

property ImportedFiberRatio.SourceMaximum : Ansys.Core.Units.Quantity | None

SourceMaximum property.

property ImportedFiberRatio.SourceMinimum : Ansys.Core.Units.Quantity | None

SourceMinimum property.

property ImportedFiberRatio.Suppressed : bool | None

Gets or sets the Suppressed.

property ImportedFiberRatio.UnmappedNodesName : str | None

UnmappedNodesName property.

property ImportedFiberRatio.VariableType : Ansys.Mechanical.DataModel.Enums.MappingVariableType | None

VariableType property.

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

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

property ImportedFiberRatio.Weighting : Ansys.Mechanical.DataModel.Enums.WeightingType | None

Weighting property.

Method detail

ImportedFiberRatio.Activate()

Activate the current object.

ImportedFiberRatio.AddComment()

Creates a new child Comment.

ImportedFiberRatio.AddFigure()

Creates a new child Figure.

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

ImportedFiberRatio.AddMappingValidation()

Creates a new MappingValidation

ImportedFiberRatio.ClearGeneratedData()

Run the ClearGeneratedData action.

ImportedFiberRatio.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ImportedFiberRatio.CreateParameter(propName: str)

Creates a new parameter for a Property.

ImportedFiberRatio.Delete()

Run the Delete action.

ImportedFiberRatio.Duplicate()

Creates a copy of the current DataModelObject.

ImportedFiberRatio.ExportToTextFile(filePath: str)

Run the ExportToTextFile action.

ImportedFiberRatio.GetActivateAtLoadStep(stepNumber: int)

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

ImportedFiberRatio.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ImportedFiberRatio.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ImportedFiberRatio.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ImportedFiberRatio.Import()

Import.

ImportedFiberRatio.ImportLoad()

Run the ImportLoad action.

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

ImportedFiberRatio.PropertyByName(name: str)

Get a property by its unique name.

ImportedFiberRatio.ReloadConfiguration()

Reload the Imported Load’s setup from its associated configuration file (if available).

ImportedFiberRatio.RemoveParameter(propName: str)

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

ImportedFiberRatio.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

SetActivateAtLoadStep method.