RARoiRefinementItem

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

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper for one Adaptive SPH Sizing ROI refinement row.

This wrapper corresponds to one item inside RASphAdaptiveSizing.RARoiRefinementItemList.

Access individual roi level via a RASphAdaptiveSizing’s roi level list:

roi_ref_levels = sph_adaptive_sizing.GetRoiRefinementLevels()
roi_level_1 = roi_ref_levels[0]
roi_level_2 = roi_ref_levels.New()

Every RARoiRefinementItem contains two properties that define a ROI refinement level: the Region of Interest and the level value:

roi_level = roi_ref_levels.New()
roi_level.SetRoi('MyRoiCube')
roi_level.SetLevelOfRefinement(2)

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetLevelOfRefinement	Get the value of “Level of Refinement”.
SetLevelOfRefinement	Set the value of “Level of Refinement”.
GetRoi	Get the “Roi”.
SetRoi	Set the “Roi”.
GetAvailableRois	Get all available Rois.

Import detail

from ansys.rocky.app.ra_sph_refinement import RARoiRefinementItem

Method detail

classmethod RARoiRefinementItem.GetWrappedClass() → type[rocky30.models.sph.sph_refinement_criteria.ROIRefinementItem]

classmethod RARoiRefinementItem.GetClassName() → str

RARoiRefinementItem.GetLevelOfRefinement() → int

Get the value of “Level of Refinement”.

RARoiRefinementItem.SetLevelOfRefinement(value: str | int) → None

Set the value of “Level of Refinement”.

Parameters:

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

RARoiRefinementItem.GetRoi() → None | ansys.rocky.app.ra_region_of_interest_cube.RARegionOfInterestCube | ansys.rocky.app.ra_region_of_interest_cylinder.RARegionOfInterestCylinder

Get the “Roi”.

Return type:

RARegionOfInterestCube, RARegionOfInterestCylinder

RARoiRefinementItem.SetRoi(value: str | ansys.rocky.app.ra_region_of_interest_cube.RARegionOfInterestCube | ansys.rocky.app.ra_region_of_interest_cylinder.RARegionOfInterestCylinder) → None

Set the “Roi”.

:param unicode, RARegionOfInterestCube, RARegionOfInterestCylinder value:

Either the API object wrapping the desired entity or its name.

RARoiRefinementItem.GetAvailableRois() → list[ansys.rocky.app.ra_region_of_interest_cube.RARegionOfInterestCube | ansys.rocky.app.ra_region_of_interest_cylinder.RARegionOfInterestCylinder]

Get all available Rois.

Return type:

List[RARegionOfInterestCube, RARegionOfInterestCylinder] A list of RARegionOfInterestCube, RARegionOfInterestCylinder.