RASphAdaptiveSizing

class ansys.rocky.app.ra_sph_refinement.RASphAdaptiveSizing(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper for the SPH Adaptive Sizing.

sph_settings = study.GetSphSettings()
sph_adaptive_sizing = sph_settings.GetAdaptiveSizing()

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetGeometries	Get the “Adaptive Sph Sizing Geometries”.
SetGeometries	Set the “Adaptive Sph Sizing Geometries”.
GetAvailableGeometries	Get all available Adaptive Sph Sizing Geometries.
GetRoiRefinementLevels	Get the Adaptive SPH Sizing ROI refinement levels table.
GetEnabled	Get the value of “Enabled”.
SetEnabled	Set the value of “Enabled”.
Enable	Set the value of “” to True.
Disable	Set the value of “” to False.
IsEnabled	Check if the “” is enabled.
GetGeometriesLevelOfRefinement	Get the value of “Geometries Level of Refinement”.
SetGeometriesLevelOfRefinement	Set the value of “Geometries Level of Refinement”.
GetGeometriesRefinementDistanceFactor	Get the value of “Geometries Refinement Distance Factor”.
SetGeometriesRefinementDistanceFactor	Set the value of “Geometries Refinement Distance Factor”.

Import detail

from ansys.rocky.app.ra_sph_refinement import RASphAdaptiveSizing

Method detail

classmethod RASphAdaptiveSizing.GetWrappedClass() → type[rocky30.models.sph.sph_refinement_criteria.SPHRefinementCriteria]

classmethod RASphAdaptiveSizing.GetClassName() → str

RASphAdaptiveSizing.GetGeometries() → list[ansys.rocky.app.ra_wall.RAWall | ansys.rocky.app.conveyors.ra_feed_conveyor.RAFeedConveyor | ansys.rocky.app.conveyors.ra_receiving_conveyor.RAReceivingConveyor | ansys.rocky.app.ra_system_coupling_wall.RASystemCouplingWall]

Get the “Adaptive Sph Sizing Geometries”.

Return type:

List[RAWall, RAFeedConveyor, RAReceivingConveyor, RASystemCouplingWall] A list of RAWall, RAFeedConveyor, RAReceivingConveyor, RASystemCouplingWall.

RASphAdaptiveSizing.SetGeometries(values: Iterable[ansys.rocky.app.ra_wall.RAWall | ansys.rocky.app.conveyors.ra_feed_conveyor.RAFeedConveyor | ansys.rocky.app.conveyors.ra_receiving_conveyor.RAReceivingConveyor | ansys.rocky.app.ra_system_coupling_wall.RASystemCouplingWall | str]) → None

Set the “Adaptive Sph Sizing Geometries”.

:param List[str, RAWall, RAFeedConveyor, RAReceivingConveyor, RASystemCouplingWall] values:

A list with names, RAWall, RAFeedConveyor, RAReceivingConveyor, RASystemCouplingWall.

RASphAdaptiveSizing.GetAvailableGeometries() → list[ansys.rocky.app.ra_wall.RAWall | ansys.rocky.app.conveyors.ra_feed_conveyor.RAFeedConveyor | ansys.rocky.app.conveyors.ra_receiving_conveyor.RAReceivingConveyor | ansys.rocky.app.ra_system_coupling_wall.RASystemCouplingWall]

Get all available Adaptive Sph Sizing Geometries.

Return type:

List[RAWall, RAFeedConveyor, RAReceivingConveyor, RASystemCouplingWall] A list of RAWall, RAFeedConveyor, RAReceivingConveyor, RASystemCouplingWall.

RASphAdaptiveSizing.GetRoiRefinementLevels() → RARoiRefinementItemList

Get the Adaptive SPH Sizing ROI refinement levels table.

RASphAdaptiveSizing.GetEnabled() → bool

Get the value of “Enabled”.

RASphAdaptiveSizing.SetEnabled(value: bool) → None

Set the value of “Enabled”.

Parameters:

value – The value to set.

RASphAdaptiveSizing.Enable() → None

Set the value of “” to True.

RASphAdaptiveSizing.Disable() → None

Set the value of “” to False.

RASphAdaptiveSizing.IsEnabled() → bool

Check if the “” is enabled.

RASphAdaptiveSizing.GetGeometriesLevelOfRefinement() → int

Get the value of “Geometries Level of Refinement”.

RASphAdaptiveSizing.SetGeometriesLevelOfRefinement(value: str | int) → None

Set the value of “Geometries Level of Refinement”.

Parameters:

value – The value to set. This value can be an expression with input variables or int type.

RASphAdaptiveSizing.GetGeometriesRefinementDistanceFactor() → float

Get the value of “Geometries Refinement Distance Factor”.

RASphAdaptiveSizing.SetGeometriesRefinementDistanceFactor(value: str | float) → None

Set the value of “Geometries Refinement Distance Factor”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.